CLI Command Reference (V5)
Asset Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Viewing AI Component Details | hcloud HSS ListAiComponentDetail/v5 | This API is used to query details about an AI component. | |
| Querying AI Component Statistics | hcloud HSS ListAiComponentStatistics/v5 | This API is used to query AI component statistics. | |
| Obtaining the Historical Change Records of Software Information | hcloud HSS ListAppChangeHistories/v5 | This API is used to obtain the historical change records of software information. | |
| Querying the Software List | hcloud HSS ListAppStatistics/v5 | This API is used to query the software list. The number of servers can be queried by software name. | |
| Querying the Server List of the Software | hcloud HSS ListApps/v5 | This API is used to query the server list of the software. | |
| Querying the Status of a Global Asset Scan Task | hcloud HSS ListGlobalAssetScanTask/v5 | This API is used to query the status of a global asset scan task. | |
| Creating a Global Asset Scan Task | hcloud HSS CreateGlobalAssetScanTask/v5 | This API is used to create a global asset scan task. | |
| Obtaining the Historical Change Records of Auto-started Items | hcloud HSS ListAutoLaunchChangeHistories/v5 | This API is used to obtain the historical change records of auto-startup items. | |
| Querying Automatic Startup Item Information | hcloud HSS ListAutoLaunchStatistics/v5 | This API is used to query the automatic startup information. The startup type and number of servers can be queried based on the automatic startup name. | |
| Querying the Service List of Auto-Started Items | hcloud HSS ListAutoLaunchs/v5 | This API is used to query the service list of auto-started items. | |
| Querying the Description of a Port | hcloud HSS ShowCommonPort/v5 | Check details about a port. Example: Local port: 80. Type: TCP. Risk level: normal. Port description: It is usually used for Secure Shell (SSH) remote login, secure login, file transfer (via SCP and SFTP), and port redirection. | |
| Exporting Asset Fingerprint Information | hcloud HSS DownloadAssetFile/v5 | This API is used to export asset fingerprint information. | |
| Querying the List of Servers with a Specified Kernel Module | hcloud HSS ListKernelModuleHostInfo/v5 | This API is used to query the list of servers with a specified kernel module. | |
| Querying the List of Servers with a Specified Web Framework | hcloud HSS ListWebFrameworkHostInfo/v5 | This API is used to query the list of servers with a specified web framework. | |
| Querying the List of Servers with a Specified Website | hcloud HSS ListWebSiteHostInfo/v5 | This API is used to query the list of servers with a specified website. | |
| Querying the Asset Fingerprint Collection Status of a Single Server | hcloud HSS ShowHostAssetManualCollectStatus/v5 | This API is used to query the asset fingerprint collection status of a single server. | |
| Collecting Asset Fingerprints of a Single Server | hcloud HSS RunHostAssetManualCollect/v5 | This API is used to collect asset fingerprints of a single server. | |
| Querying the Server List of a Specified Middleware | hcloud HSS ListJarPackageHostInfo/v5 | This API is used to query the server list of a specified middleware. You can query the middleware server list by its middleware name. | |
| Querying the Middleware List | hcloud HSS ListJarPackageStatistics/v5 | This API is used to query the middleware list. It can query the number of servers by middleware name. | |
| Asset Management - Overview - Top Accounts | hcloud HSS ShowAccountTop/v5 | Asset Management - Overview - Top Accounts | |
| Asset Management - Overview - Top Auto-started Items | hcloud HSS ShowAutoLaunchTop/v5 | Asset Management - Overview - Top Auto-started Items | |
| Asset Management - Overview - Top JAR Packages | hcloud HSS ShowJarPackageTop/v5 | Asset Management - Overview - Top JAR Packages | |
| Asset Management - Overview - Top Kernel Modules | hcloud HSS ShowKernelModuleTop/v5 | Asset Management - Overview - Top Kernel Modules | |
| Asset Management - Overview - Top Ports | hcloud HSS ShowPortTop/v5 | Asset Management - Overview - Top Ports | |
| Asset Management - Overview - Top Processes | hcloud HSS ShowProcessTop/v5 | Asset Management - Overview - Top Processes | |
| Asset Management - Overview - Software Top | hcloud HSS ShowSoftwareTop/v5 | Asset Management - Overview - Software Top | |
| Asset Management - Overview - WebAppAndServiceTop | hcloud HSS ShowWebAppAndServiceTop/v5 | Asset Management - Overview - Top 5 Web Applications/Services | |
| Asset Management - Overview - Web Framework Top | hcloud HSS ShowWebFrameworkTop/v5 | Asset Management - Overview - Web Framework Top | |
| Asset Management - Overview - Top Websites | hcloud HSS ShowWebSiteTop/v5 | Asset Management - Overview - Top Websites | |
| Asset Management - Overview - Asset Status - Server Agent Status | hcloud HSS ShowAgentStatisticsStatus/v5 | Asset Management - Overview - Asset Status - Server Agent Status | |
| Asset Management - Overview - Asset Status - Container Node Protection Status | hcloud HSS ShowContainerProtectionStatus/v5 | Asset Management - Overview - Asset Status - Container Node Protection Status | |
| Asset Management - Overview - Asset Status - Agent Status | hcloud HSS ShowHostProtectionStatus/v5 | Asset Management - Overview - Asset Status - Agent Status | |
| Asset Management - Overview - Asset Status - OS Statistics | hcloud HSS ShowOsStatisticsInfo/v5 | Asset Management - Overview - Asset Status - OS Statistics | |
| Asset Management - Overview - Asset Status - Protection Quota Statistics | hcloud HSS ShowQuotaStatisticsInfo/v5 | Asset Management - Overview - Asset Status - Protection Quota Statistics | |
| Querying Open Port Statistics | hcloud HSS ListPortStatistics/v5 | This API is used to query the list of open ports. The number of servers can be queried by port or protocol type. | |
| Querying the List of Servers with a Specified Open Port | hcloud HSS ListPortHost/v5 | This API is used to query the list of servers or container hosts with the port. | |
| Querying the Open Port List of a Single Server | hcloud HSS ListPorts/v5 | This API is used to query the open port list of a single server. | |
| Querying Process Statistics | hcloud HSS ListProcessStatistics/v5 | This API is used to query the process list and query the number of servers based on the process path parameter. | |
| Querying the List of Servers with a Specified Process | hcloud HSS ListProcessesHost/v5 | This API is used to query the list of servers or container hosts with the process. | |
| Querying Kernel Module Statistics | hcloud HSS ListKernelModuleStatistics/v5 | This API is used to query the number of servers with the kernel module. | |
| Querying Web Framework Statistics | hcloud HSS ListWebFrameworkStatistics/v5 | This API is used to query the number of servers with the web framework. | |
| Querying Website Statistics | hcloud HSS ListWebSiteStatistics/v5 | This API is used to query the number of servers with the website. | |
| Querying the Number of Assets | hcloud HSS ShowAssetStatistic/v5 | This API is used to collect statistics on assets, such as accounts, ports, and processes. | |
| Obtaining the Account Change History | hcloud HSS ListUserChangeHistories/v5 | This API is used to obtain the account change history. | |
| Querying the Account List | hcloud HSS ListUserStatistics/v5 | This API is used to query the account list. The number of servers can be queried based on the account name parameter. | |
| Querying the Server List of an Account | hcloud HSS ListUsers/v5 | This API is used to query the server list of an account. | |
| Querying Statistics About Web Services, Web Applications, and Databases | hcloud HSS ListWebAppAndServiceStatistics/v5 | This API is used to query the number of servers with a web service, web application, and database. | |
| Querying the Server List of a Web Service, Web Application, or Database | hcloud HSS ListWebAppAndServices/v5 | This API is used to query the server list of a web service, web application, or database. | |
| Querying the Middleware Information of a Server | hcloud HSS ListJarPackageInfo/v5 | This API is used to query the middleware information of a server. | |
| Querying the Kernel Module Information of a Server | hcloud HSS ListKernelModuleInfo/v5 | This API is used to query the kernel module information of a server. | |
| Querying the Web Framework Information of a Server | hcloud HSS ListWebFrameworkInfo/v5 | This API is used to query the web framework information of a server. | |
| Querying the Website Information of a Server | hcloud HSS ListWebSiteInfo/v5 | This API is used to query the website information of a server. |
Ransomware Prevention
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Backup Policy Bound to HSS Protection Vault | hcloud HSS ShowBackupPolicyInfo/v5 | This API is used to query the backup policy bound to the HSS protection vault. Ensure that a ransomware protection vault has been purchased in CBR. Such a vault is named in the HSS_projectid format. | |
| Modifying the Backup Policy Bound to Vault | hcloud HSS UpdateBackupPolicyInfo/v5 | This API is used to modify the backup policy associated with the vault. | |
| Querying Information About a Backup Policy | hcloud HSS ShowSingleBackupPolicyInfo/v5 | This API is used to query information about a backup policy. | |
| Binding a Repository to a Backup Policy | hcloud HSS AssociateBackupPolicy/v5 | This API is used to bind a repository to a backup policy. | |
| Querying the Backup and Restoration Task List | hcloud HSS ListOperationLogsByVaultName/v5 | This API is used to query the list of backup and restoration tasks. | |
| Reviewing Backup Policies | hcloud HSS ListBackupPolicy/v5 | This API is used to query the backup policy list. | |
| Fetching Specific Backup Details | hcloud HSS ShowBackupInfoByBackupId/v5 | This API is used to query a specific backup. | |
| Listing Backups | hcloud HSS ListBackedupByHostId/v5 | This API is used to query the backup list. | |
| Restoring Data Using a Backup | hcloud HSS RestoreDuplicationInfo/v5 | This API is used to restore data using a backup. | |
| Deleting Backup Copies | hcloud HSS DeleteDuplicationInfo/v5 | This API is used to delete backup copy. | |
| Querying the Backup Vault List | hcloud HSS ListBackupVaults/v5 | This API is used to query the backup vault list. If a server needs to be bound, the following conditions must be met: 1. The vault is in the Available state. 2. The backup policy is in the Enabled state. 3. The vault has available backup capacity. 4. The number of servers bound to the vault is less than 256. | |
| Enabling Ransomware Protection 2.0 in Batches | hcloud HSS BatchStartProtection/v5 | This API is used to enable ransomware prevention for multiple servers at a time. If you want to enable backup, ensure CBR is available in the region. | |
| Disabling Ransomware Prevention | hcloud HSS StopProtection/v5 | This API is used to disable ransomware prevention. | |
| Enabling Ransomware Prevention | hcloud HSS StartProtection/v5 | This API is used to enable ransomware prevention. Ensure that the region has Cloud Backup and Recovery (CBR), because ransomware prevention depends on it. | |
| Switching the Ransomware Protection Policy | hcloud HSS AssociateProtectionPolicy/v5 | This API is used to switch a ransomware protection policy. | |
| Querying the Protection Policy List of Ransomware | hcloud HSS ListProtectionPolicy/v5 | This API is used to query the protection policy list of ransomware. | |
| Modifying Ransomware Protection Policies | hcloud HSS UpdateProtectionPolicy/v5 | This API is used to modify ransomware protection policies. | |
| Adding a Protection Policy | hcloud HSS AddProtectionPolicy/v5 | This API is used to add a protection policy. | |
| Deleting a Protection Policy | hcloud HSS DeleteProtectionPolicy/v5 | This API is used to delete a protection policy. | |
| Querying the Servers Protected Against Ransomware | hcloud HSS ListProtectionServer/v5 | This API is used to query the list of servers protected against ransomware. This API needs to be used together with Cloud Backup and Recovery (CBR). Ensure the site has CBR before using ransomware-related APIs. | |
| Querying the Ransomware Protection Server List 2.0 | hcloud HSS ListRansomwareProtectionNodes/v5 | This API is used to query the list of servers protected against ransomware. This API needs to be used together with Cloud Backup and Recovery (CBR). Ensure the site has CBR before using ransomware-related APIs. |
Baseline Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Ignoring, Unignoring, Repairing, or Verifying the Failed Configuration Check Items | hcloud HSS ChangeCheckRuleAction/v5 | This API is used to ignore, unignore, repair, or verify the failed configuration check items. | |
| Querying the Report of a Check Item in a Security Configuration Check | hcloud HSS ShowCheckRuleDetail/v5 | This API is used to query the report of a check item in a security configuration check. | |
| Querying Causes of Check Item Repair Failures | hcloud HSS ShowCheckRuleFixFailDetail/v5 | This API is used to query reasons for failed repair attempts of an inspection item. | |
| Querying the Impact Scope of a Baseline Check | hcloud HSS ListHandleAffectBaseline/v5 | This API is used to query the impact scope of a baseline check. | |
| Querying Lists of Servers Affected by Configuration Check Items | hcloud HSS ListCheckRuleHost/v5 | This API is used to query the server list affected by a configuration check item. | |
| Manually Checking for Unsafe Settings and Weak Passwords for Selected Servers in a Policy | hcloud HSS RunBaselineDetect/v5 | This API is used to manually check for unsafe settings and weak passwords for selected servers in a policy. | |
| Exporting Baseline Check Reports from the Backend as Excel Files | hcloud HSS ExportBaselineSecurityCheckReport/v5 | This API is used to export baseline check reports from the backend as Excel files. | |
| Inspecting Server Check Items | hcloud HSS ListHostCheckRules/v5 | This API is used to query lists of servers affected by configuration check items. | |
| Querying Baseline Check Statistics | hcloud HSS ShowBaselineOverview/v5 | This API is used to query statistics for baseline checks and display statistics and chart data on the baseline check page, including last scan time, number of checked servers, number of checked baseline items, number of checked server configuration items, pass rate of server configuration baselines, top 5 host configuration risks, weak password detection statistics, and top 5 weak password risks. | |
| Ignoring or Unignoring Servers that Fail the Password Complexity Check | hcloud HSS ChangePasswordComplexityStatus/v5 | This API is used to ignore or cancel the ignorance of servers that fail the password complexity check. | |
| Querying the Password Complexity Policy Detection Report | hcloud HSS ListPasswordComplexity/v5 | This API is used to query the password complexity policy detection report. | |
| Exploring Policy Group Check Items | hcloud HSS ListAllRiskConfigCheckRules/v5 | This API is used to query the check item list of a specified policy group. | |
| Exporting Configuration Check Reports Based on Query Results | hcloud HSS ExportSecurityCheckReport/v5 | This API is used to export the configuration check report to an Excel file based on the query results. | |
| Querying the Checklist of a Security Configuration Item | hcloud HSS ListRiskConfigCheckRules/v5 | This API is used to query the checklist of a specified security configuration item. | |
| Querying the Check Result of a Security Configuration Item | hcloud HSS ShowRiskConfigDetail/v5 | This API is used to query the check result of a specified security configuration item. | |
| Querying the List of Affected Servers of a Security Configuration Item | hcloud HSS ListRiskConfigHosts/v5 | This API is used to query the list of affected servers of a specified security configuration item. | |
| Querying the Result List of Server Security Configuration Check | hcloud HSS ListRiskConfigs/v5 | This API is used to query the result list of a user's server security configuration check. | |
| Querying Manual Baseline Scan Results | hcloud HSS ShowBaselineScanStatus/v5 | This API is used to query the manual baseline scan result. | |
| Querying Detailed Check Items of a Baseline | hcloud HSS ShowDefaultSecurityCheckPolicyDetails/v5 | This API is used to query detailed check items of a baseline. | |
| Querying Default Baseline Information of Configuration Check Policy | hcloud HSS ShowDefaultSecurityCheckPolicy/v5 | This API is used to query default baseline information for configuration detection policies. | |
| Querying the Baseline Directory Information of a Baseline Detection Policy | hcloud HSS ShowBaselineDirectory/v5 | This API is used to query the baseline directory information of a baseline detection policy. | |
| Creating a Configuration Check Policy | hcloud HSS AddSecurityCheckPolicyGroup/v5 | This API is used to create a configuration check policy. | |
| Modifying Specified Configuration Detection Policy Information | hcloud HSS UpdateSecurityCheckPolicyGroup/v5 | This API is used to modify specified configuration detection policy information. | |
| Deleting Specified Configuration Detection Policy Information | hcloud HSS DeleteSecurityCheckPolicyGroup/v5 | This API is used to delete specified configuration detection policy information. | |
| Copying Configuration Detection Policy Information | hcloud HSS CopyBaselinePolicyGroup/v5 | This API is used to copy configuration detection policy information. | |
| Querying Configuration Check Policy Groups | hcloud HSS ListSecurityCheckPolicyGroup/v5 | This API is used to query the configuration check policy group list. | |
| Querying Statistics of Baseline Checks Including Weak Passwords, Password Complexity, and Configuration Checks | hcloud HSS ShowBaselineStatistic/v5 | This API is used to query risk statistics for baseline checks, including weak passwords, password complexity, and configuration checks. | |
| Querying the Weak Password Detection Result List | hcloud HSS ListWeakPasswordUsers/v5 | This API is used to query the list of weak password detection results. | |
| Added baseline whitelists. | hcloud HSS AddBaselineWhiteList/v5 | This API is used to add baseline whitelists. | |
| Deleting a Baseline Whitelist | hcloud HSS DeleteBaselineWhiteList/v5 | This API is used to delete a baseline whitelist. | |
| Modifying the Baseline Whitelist | hcloud HSS ChangeBaselineWhiteList/v5 | This API is used to modify the baseline whitelist. | |
| Querying a Single Baseline Whitelist | hcloud HSS ShowBaselineWhiteList/v5 | This API is used to query a single baseline whitelist. | |
| Querying the Baseline Whitelist | hcloud HSS ListBaselineWhiteLists/v5 | This API is used to query the baseline whitelist. |
Quota Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Quota Details | hcloud HSS ListQuotasDetail/v5 | This API is used to query quota details. | |
| Querying Quota Information | hcloud HSS ShowResourceQuotas/v5 | This API is used to query quota information. | |
| Unbinding a Quota | hcloud HSS CancelHostsQuota/v5 | This API is used to unbind a quota. | |
| Querying Quota IDs in Batches | hcloud HSS ListResourceIds/v5 | This API is used to query quota IDs in batches. | |
| Querying the Latest Version Used by a Customer | hcloud HSS ShowVersion/v5 | This API is used to query the latest version used by a customer. | |
| Querying Product and Offering Information | hcloud HSS ShowProductdataOfferingInfos/v5 | This API is used to query product and offering information. | |
| Creating an Order Quota by HSS | hcloud HSS CreateQuotasOrder/v5 | The billing mode can only be yearly/monthly when an order quota is created by HSS. | |
| Querying the Resource Locking Status | hcloud HSS ListLockedStatus/v5 | While a pay-per-use protection quota is being changed to yearly/monthly billing, the quota is locked. The billing mode cannot be changed to yearly/monthly for a locked quota. You can use this API to query the locking status of the server quota. |
Container Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of Commands Running in a Container | hcloud HSS ListContainerCmdLogs/v5 | This API is used to query the list of commands running in a container. | |
| Creating a Container Export Task | hcloud HSS ExportContainerList/v5 | This API is used to create a container export task. | |
| Querying Basic Container Information List | hcloud HSS ListContainers/v5 | This API is used to query the basic container information list. | |
| Querying the Container Log List | hcloud HSS ListContainerLogs/v5 | This API is used to query the container log list. | |
| Querying the Protection Overview Data of a Container Node | hcloud HSS ShowContainerNodeStatistics/v5 | This API is used to query the protection overview data of a container node. | |
| Querying the Container Node List | hcloud HSS ListContainerNodes/v5 | This API is used to query the container node list. | |
| Changing Protection Status | hcloud HSS SwitchContainerProtectStatus/v5 | This API is used to switch the protection status. | |
| Querying the Kubernetes Cluster List | hcloud HSS ListKubernetesClusterDetails/v5 | This API is used to query the Kubernetes cluster list. | |
| Querying Container Details | hcloud HSS ShowK8sContainerDetail/v5 | This API is used to query container details. | |
| Querying Kubernetes Endpoint Details | hcloud HSS ShowKubernetesEndpointInfo/v5 | This API is used to query Kubernetes endpoint details. | |
| Querying the Kubernetes Endpoint List | hcloud HSS ListKubernetesEndpointDetails/v5 | This API is used to query the Kubernetes endpoint list. | |
| Querying the Basic Pod Information List | hcloud HSS ListK8sPods/v5 | This API is used to query the basic pod information list. | |
| Synchronizing Cluster Information | hcloud HSS CreateClustersInfo/v5 | This API is used to synchronize cluster information. | |
| Querying Kubernetes Service Details | hcloud HSS ShowKubernetesServiceInfo/v5 | This API is used to query Kubernetes service details. | |
| Querying the Kubernetes Service List | hcloud HSS ListKubernetesServiceDetails/v5 | This API is used to query the Kubernetes service list. | |
| Handling Container Lifecycles | hcloud HSS ChangeContainerStatus/v5 | This API is used to manage the container lifecycle. | |
| Querying Pod Details | hcloud HSS ShowK8sPodDetail/v5 | This API is used to query pod details. |
Event Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Downloading Export Files | hcloud HSS ListDownloadExportedFile/v5 | This API is used to download export files. | |
| Querying the Statistics of ATT&CK Phases | hcloud HSS ListEventAttCk/v5 | This API is used to query statistics of ATT&CK phases. | |
| Querying the Attack Identifier Distribution Statistics List | hcloud HSS ShowEventAttackTag/v5 | This API is used to query attack identifier distribution statistics. | |
| Querying the List of Blocked IP Addresses | hcloud HSS ListBlockedIp/v5 | This API is used to query the list of blocked IP addresses. | |
| Unblocking a Blocked IP Address | hcloud HSS ChangeBlockedIp/v5 | This API is used to unblock a blocked IP address. | |
| Downloading Alarm Source Files | hcloud HSS DownloadEventSourceFile/v5 | This API is used to download the alarm source file. | |
| Querying the Event Type Statistics List | hcloud HSS ListEventType/v5 | This API is used to query event type statistics. | |
| Investigating Event Forensics Data | hcloud HSS ShowExportTask/v5 | This API is used to query export tasks. | |
| Submitting a Vulnerability Export Request | hcloud HSS ExportEventRequest/v5 | This API is used to request for exporting intrusion events. | |
| Exporting Vulnerability Reports | hcloud HSS ListEventForensic/v5 | This API is used to query the forensics information about a specific event. | |
| Querying the List of Isolated Files | hcloud HSS ListIsolatedFile/v5 | This API is used to query the list of isolated files. | |
| Restoring Isolated Files | hcloud HSS ChangeIsolatedFile/v5 | This API is used to restore isolated files. | |
| Deleting Isolated Files | hcloud HSS DeleteIsolatedFile/v5 | This API is used to delete isolated files. | |
| Querying Alarms Associated with an Alarm Event | hcloud HSS ListRelatedEvents/v5 | This API is used to query the alarms associated with an alarm event. | |
| Querying Export Tasks | hcloud HSS ListQueryExportTask/v5 | This API is used to query export tasks. | |
| Querying Export Tasks | hcloud HSS ShowLatestExportTaskByType/v5 | This API is used to query export tasks. |
Intrusion Detection
Server Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Server List - Public API | hcloud HSS ListCommonHost/v5 | This API is used to query the server list. (Public API) | |
| Querying the Agent History Status List | hcloud HSS ListAgentStatus/v5 | This API is used to query the agent history status list. | |
| Configuring Asset Importance | hcloud HSS AssociateHostAssetValue/v5 | This API is used to configure asset importance. | |
| Configuring Server Resources in Batches | hcloud HSS BatchUpdateHostResource/v5 | This API is used to configure server resources in batches. | |
| Modifying Firewall Authorization Statuses | hcloud HSS SwitchFirewallStatus/v5 | This API is used to modify firewall authorization status. | |
| Assigning to a Group | hcloud HSS AssociateHostsGroup/v5 | This API is used to assign objects to groups. | |
| Querying Server Groups | hcloud HSS ListHostGroups/v5 | This API is used to query server groups. | |
| Creating a Server Group | hcloud HSS AddHostsGroup/v5 | This API is used to create a server group. | |
| Editing a Server Group | hcloud HSS ChangeHostsGroup/v5 | This API is used to edit a server group. | |
| Deleting a Server Group | hcloud HSS DeleteHostsGroup/v5 | This API is used to delete a server group. | |
| Collecting Server Statistics | hcloud HSS ShowHostsStatistics/v5 | This API is used to collect server statistics. | |
| ECS Risk Status | hcloud HSS ListHostsRisk/v5 | This API is used to query the ECS risk status. | |
| Querying ECSs | hcloud HSS ListHostStatus/v5 | This API is used to query ECSs. | |
| Querying the Server Policy List | hcloud HSS ListPolicies/v5 | This API is used to query the server policy list. | |
| Changing the Protection Status | hcloud HSS SwitchHostsProtectStatus/v5 | This API is used to change the protection status. | |
| Uninstalling the Agent | hcloud HSS UninstallAgents/v5 | This API is used to uninstall the agent. | |
| Upgrading the Agent | hcloud HSS UpgradeAgents/v5 | This API is used to upgrade the agent. | |
| Checking Server Endpoint Creation Status | hcloud HSS ShowEndpointStatus/v5 | This API is used to query the creation status of each server endpoint. | |
| Creating a VPC Endpoint | hcloud HSS CreateVpcEndpoint/v5 | Create a VPC endpoint. | |
| Delivering a Manual Scan | hcloud HSS SetManualDetect/v5 | This API is used to deliver a manual scan. | |
| Initiating Manual Scans | hcloud HSS ShowScanStatus/v5 | This API is used to query the manual scan status. | |
| Ignoring or Unignoring Servers | hcloud HSS ChangeHostIgnoreStatus/v5 | This API is used to ignore or unignore a server. | |
| Querying the Status of the Automatic Quota Binding Switch | hcloud HSS ListAutoOpenQuotaStatus/v5 | This API is used to query the status of the automatic quota binding switch. | |
| Enabling or Disabling the Automatic Quota Binding Function | hcloud HSS ChangeAutoOpenQuotaStatus/v5 | This API is used to enable or disable the automatic quota binding function. |
Policy Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Applying a Policy Group | hcloud HSS AssociatePolicyGroup/v5 | This API is used to deploy a policy group for servers with premium or container protection enabled. | |
| Copying a Policy Group | hcloud HSS AddPolicyGroup/v5 | This API is used to copy a policy group. You can copy an existing premium or container edition policy group to create a new one. | |
| Deleting a Policy Group | hcloud HSS DeletePolicyGroup/v5 | This API is used to delete a non-default policy groups that are not associated with servers. | |
| Modifying a Policy Group | hcloud HSS ChangePolicyGroup/v5 | This API is used to modify a policy group, such as changing its protection mode. | |
| Querying the Policy Group List | hcloud HSS ListPolicyGroup/v5 | This API is used to query the policy group list. |
Vulnerability Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Viewing the Handling History of Image Vulnerabilities | hcloud HSS ListGeneralImageVulOperations/v5 | This API is used to view the handling history of an image vulnerability. | |
| Viewing the Vulnerabilities of All Types of Images | hcloud HSS ListGeneralImageVuls/v5 | This API is used to view the vulnerabilities of all image types. | |
| Exporting Information About Vulnerabilities and Their Affected Servers | hcloud HSS ExportVuls/v5 | This API is used to export information about vulnerabilities and their affected servers. | |
| Querying the Backup Statistics of the Servers Where Vulnerabilities Were Handled | hcloud HSS ShowVulBackupStatistics/v5 | This API is used to query backup statistics of the servers where vulnerabilities were handled. | |
| Querying the List of Backups That Can Be Rolled Back | hcloud HSS ListVulHostBackups/v5 | This API is used to query the list of backups available for rollback. | |
| Querying the List of Server Vaults Corresponding to Vulnerability Handling | hcloud HSS ListVulHostVaults/v5 | This API is used to query the list of server vaults corresponding to vulnerability handling. | |
| Performing a Rollback Using a Backup | hcloud HSS RestoreVulHostBackup/v5 | This API is used to perform a rollback using a backup. | |
| Gathering Basic Web-CMS Vulnerability Data | hcloud HSS ShowCmsVulDetail/v5 | This API is used to gather basic web-CMS vulnerability data. | |
| Querying Container Application Information Affected by a Vulnerability | hcloud HSS ListVulContainerApps/v5 | This API is used to query container application information affected by a vulnerability. | |
| Querying Information About Containers Affected by a Vulnerability | hcloud HSS ListVulContainers/v5 | This API is used to query information about containers affected by a single vulnerability. | |
| Creating a Task for Exporting Vulnerability Handling Records | hcloud HSS ExportVulHandleHistory/v5 | This API is used to create a task for exporting vulnerability handling records. | |
| Viewing Handled Vulnerabilities | hcloud HSS ListHandleVuls/v5 | This API is used to query vulnerabilities handled today versus total handled vulnerabilities. | |
| Creating a Task for Exporting Handled Vulnerabilities | hcloud HSS ExportHandledVulnerabilities/v5 | This API is used to create a task for exporting handled vulnerabilities. | |
| Displaying Server Vulnerability List | hcloud HSS ListVulHostVuls/v5 | This API is used to query the list of urgent or unfixed vulnerabilities. | |
| Inspecting Server View Vulnerabilities | hcloud HSS ListVulHostHosts/v5 | This API is used to query server vulnerabilities in the server view. | |
| Querying Vulnerability Information About a Server | hcloud HSS ListHostVuls/v5 | This API is used to query the vulnerability information about a server. | |
| Querying the Servers Affected by a Vulnerability | hcloud HSS ListVulHosts/v5 | This API is used to query the servers affected by a vulnerability. | |
| Collecting Basic Linux Vulnerability Info | hcloud HSS ShowLinuxVulDetail/v5 | This API is used to collect basic Linux vulnerability info. | |
| Extracting Vulnerability Fix Commands | hcloud HSS ListVulRepairCmds/v5 | This API is used to query the vulnerability fixing command list. | |
| Vulnerability Management - Server View - Server List - Export Report | hcloud HSS ShowVulReportData/v5 | This API is used to export the detailed vulnerability report in PDF format in the server view. | |
| Querying a Vulnerability Scan Policy | hcloud HSS ShowVulScanPolicy/v5 | This API is used to query a vulnerability scan policy. | |
| Modifying a Vulnerability Scan Policy | hcloud HSS ChangeVulScanPolicy/v5 | This API is used to modify a vulnerability scan policy. | |
| Querying the List of Servers Corresponding to a Vulnerability Scan Task | hcloud HSS ListVulScanTaskHost/v5 | This API is used to query the list of servers corresponding to a vulnerability scan task. | |
| Creating a Vulnerability Scan Task | hcloud HSS CreateVulnerabilityScanTask/v5 | This API is used to create a vulnerability scan task. | |
| Querying the Vulnerability Scan Tasks | hcloud HSS ListVulScanTask/v5 | This API is used to query the vulnerability scan tasks. | |
| Estimating Vulnerability Scan Durations | hcloud HSS ShowVulScanTaskEstimatedTime/v5 | This API is used to query the estimated vulnerability scan time. | |
| Rescanning Servers for Vulnerabilities | hcloud HSS RecreateVulScanTask/v5 | This API is used to rescan servers in the previous vulnerability scan task. | |
| Counting Affected Servers and Vulnerabilities | hcloud HSS ShowVulAffectedStatics/v5 | This API is used to query the numbers of affected servers and vulnerabilities. | |
| Querying Vulnerability Management Statistics | hcloud HSS ShowVulStatics/v5 | This API is used to query vulnerability management statistics. | |
| Changing the Status of a Vulnerability | hcloud HSS ChangeVulStatus/v5 | This API is used to change the status of a vulnerability. | |
| Obtaining the Number of Unread Vulnerability Tasks | hcloud HSS ShowVulTaskStatistics/v5 | This API is used to obtain the number of unread vulnerability tasks. | |
| Recording the Last Time When a User Viewed the Vulnerability Task Management Page | hcloud HSS RecordUserViewVulTask/v5 | This API is used to record the last time when a user viewed the vulnerability task management page. | |
| Monitoring Emergency Vulnerabilities | hcloud HSS ListUrgentVulnerabilities/v5 | This API is used to query the emergency vulnerability list. | |
| Querying the Vulnerability List | hcloud HSS ListVulnerabilities/v5 | This API is used to query the list of detected vulnerabilities. | |
| Reviewing Whitelisted Vulnerability Options | hcloud HSS ListVulWhiteListVulOptions/v5 | This API is used to query the vulnerability options added to the whitelist. | |
| Detailing Vulnerability Whitelist Records | hcloud HSS ShowVulWhiteListDetail/v5 | This API is used to query details about a vulnerability whitelist. | |
| Editing Vulnerability Whitelists | hcloud HSS ChangeVulWhiteList/v5 | This API is used to modify the vulnerability whitelist. | |
| Adding Vulnerability Whitelist Entries | hcloud HSS AddVulWhiteList/v5 | This API is used to add a vulnerability whitelist item. | |
| Deleting a Vulnerability Whitelist Item | hcloud HSS DeleteVulWhiteList/v5 | This API is used to delete a vulnerability whitelist item. | |
| Examining Vulnerability Whitelists | hcloud HSS ListVulWhiteList/v5 | This API is used to query the vulnerability whitelist. | |
| Accessing Basic Windows Vulnerability Info | hcloud HSS ShowWindowsVulDetail/v5 | This API is used to query basic information about Windows vulnerabilities. | |
| Querying Details About Affected Servers - Software List | hcloud HSS ListVulHostApps/v5 | This API is used to query details about the software list of affected servers. | |
| Identifying Vulnerability Fix Failures | hcloud HSS ListVulRepairFailedDetail/v5 | This API is used to query vulnerability fix failure information. | |
| Querying Details About Affected Servers - Process List | hcloud HSS ListVulHostProcess/v5 | This API is used to query details about the process list of affected servers. |
Web Tamper Protection
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Web Tamper Protection Event List | hcloud HSS ListWebTamperEvent/v5 | This API is used to query the web tamper protection event list. | |
| Querying the List of Servers for Where WTP Can Be Enabled | hcloud HSS ListWebTamperHost/v5 | This API is used to query the list of servers where WTP can be enabled. | |
| Exporting the List of Protected WTP Directories | hcloud HSS ExportWebTamperHost/v5 | This API is used to export the list of protected WTP directories. | |
| Querying the WTP list | hcloud HSS ListWtpProtectHost/v5 | This API is used to query the servers protected by web tamper protection (WTP). | |
| Querying Image Options of the Container WTP Edition | hcloud HSS ListWebTamperImageOptions/v5 | This API is used to query the image options of the container WTP edition. | |
| Enabling/Disabling Container WTP Protection | hcloud HSS SwitchWebTamperProtectStatus/v5 | Enabling/Disabling Container WTP Protection | |
| Creating a WTP Configuration | hcloud HSS CreateWebTamperProtectionConfig/v5 | This API is used to create a WTP configuration. | |
| Querying Web Tamper Protection Configuration List | hcloud HSS ListWebTamperProtectionConfigs/v5 | This API is used to query the web tamper protection configuration list. | |
| Modifying a WTP Configuration | hcloud HSS UpdateWebTamperProtectionConfig/v5 | This API is used to modify a WTP configuration. | |
| Deleting a WTP Configuration | hcloud HSS DeleteWebTamperProtectionConfig/v5 | This API is used to delete a WTP configuration. | |
| Querying List of Containers Associated with Protection Configuration | hcloud HSS ListWebTamperProtectionContainer/v5 | This API is used to query the list of containers associated with the protection configuration. | |
| Querying List of Protected Container Directories Associated with Protection Configuration | hcloud HSS ListWebTamperProtectionDirectory/v5 | This API is used to query the list of protected container directories associated with the protection configuration. | |
| Enabling WTP for Servers in Batches | hcloud HSS BatchStartWebTamperProtection/v5 | This API is used to enable web tamper protection for servers in batches. | |
| Querying Dynamic WTP Events | hcloud HSS ListHostRaspProtectHistoryInfo/v5 | This API is used to query dynamic WTP events. | |
| Enabling or Disabling Dynamic Web Tamper Protection | hcloud HSS SetRaspSwitch/v5 | This API is used to turn on or off dynamic web tamper protection. | |
| Querying Static WTP Events | hcloud HSS ListHostProtectHistoryInfo/v5 | This API is used to query static WTP events. | |
| Enabling or Disabling WTP | hcloud HSS SetWtpProtectionStatusInfo/v5 | This API is used to turn on or off web tamper protection. | |
| Querying Container WTP Statistics | hcloud HSS ListWebTamperProtectStatistics/v5 | This API is used to query container WTP statistics. | |
| Viewing Web Tamper Protection Policies | hcloud HSS ShowWebTamperHostPolicy/v5 | This API is used to view web tamper protection policies. | |
| Editing a Web Tamper Protection Policy | hcloud HSS UpdateWebTamperHostPolicy/v5 | This API is used to edit a web tamper protection policy. | |
| Querying the Remote Backup Server List | hcloud HSS ListBackupHostsInfo/v5 | This API is used to query the remote backup server list. | |
| Adding or Modifying a Remote Backup Server | hcloud HSS UpdateBackupHostInfo/v5 | This API is used to add or modify a remote backup server. | |
| Deleting a Remote Backup Server | hcloud HSS DeleteBackupHostInfo/v5 | This API is used to delete a remote backup server. | |
| Collecting Protection Data Statistics | hcloud HSS ShowWtpProtectStatistics/v5 | This API is used to gather protection data statistics, including the numbers of protected servers, directories, and tampering attacks defended in the last seven days. | |
| Querying Remote Backup Server Information | hcloud HSS ShowRemoteBackupHostInfo/v5 | This API is used to query information about the remote backup server, including its name, address, port number, backup path, and status. | |
| Suspending or Resuming a Protected Directory | hcloud HSS SetProtectDirSwitchInfo/v5 | This API is used to suspend or resume protection for a directory. | |
| Querying the Tomcat Bin Directory Configured for Dynamic Web Tamper Protection | hcloud HSS ShowWebTamperRaspPath/v5 | This API is used to query the Tomcat bin directory protected by dynamic WTP. | |
| Modifying the Tomcat bin Directory for Dynamic Web Tamper Protection | hcloud HSS UpdateWebTamperRaspPath/v5 | This API is used to modify the Tomcat bin directory protected by dynamic WTP. | |
| Enabling or Disabling Remote Backup | hcloud HSS SetRemoteBackupInfo/v5 | This API is used to enable or disable the remote backup function for Linux servers with WTP enabled. |
Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying All Tags Used in the Current Project of a Tenant | hcloud HSS ListProjectTags/v5 | This API is used to query all used tags in the current project of a tenant. | |
| Creating Tags in Batches | hcloud HSS BatchCreateTags/v5 | This API is used to create tags in batches. | |
| Deleting Tags in Batches | hcloud HSS BatchDeleteTags/v5 | This API is used to delete tags in batches. | |
| Deleting a Resource Tag | hcloud HSS DeleteResourceInstanceTag/v5 | This API is used to delete a tag from a resource. | |
| Querying the Tags of a Resource | hcloud HSS ListResourceInstanceTag/v5 | This API is used to query the tags of a resource. |
Antivirus
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of Servers Available for Virus Scan | hcloud HSS ListAntiVirusHost/v5 | This API is used to query the list of servers available for virus scan. | |
| Querying Free Virus Scans Count | hcloud HSS ShowAntivirusFreeQuota/v5 | This API is used to query the number of free virus scans. | |
| Querying Paid Virus Scans Server List | hcloud HSS ListAntiVirusPaidHosts/v5 | This API is used to query the server list of paid virus scans. | |
| Creating Paid Virus Scan Task | hcloud HSS CreateAntiVirusPaidTask/v5 | This API is used to create a paid virus scan task. | |
| Querying the Status of the Pay-per-use Billing Switch for Virus Scan | hcloud HSS ShowAntivirusPayPerScanStatus/v5 | This API is used to query the status of the pay-per-use billing switch for virus scan. | |
| Changing the Status of the Pay-per-use Billing Switch for Virus Scan | hcloud HSS ChangeAntivirusPayPerScanStatus/v5 | This API is used to change the status of the switch of the pay-per-use billing switch for virus scan. | |
| Deleting a Custom Scan Policy | hcloud HSS DeleteAntivirusPolicy/v5 | This API is used to delete a custom scan policy. | |
| Creating a Custom Scan Policy | hcloud HSS CreateAntiVirusPolicy/v5 | This API is used to create a custom scan policy. | |
| Querying a Custom Scan Policy List | hcloud HSS ListAntiVirusPolicy/v5 | This API is used to query the custom scan policy list. | |
| Editing a Custom Scan Policy | hcloud HSS ChangeAntivirusPolicy/v5 | This API is used to edit a custom scan policy. | |
| Exporting the Virus Scan Result List | hcloud HSS ExportAntiVirusResult/v5 | This API is used to export the virus scan result list. | |
| Handling Virus Scan Results | hcloud HSS HandleAntiVirusResult/v5 | This API is used to handle virus scan results. | |
| Querying the Virus Scan Result List | hcloud HSS ListAntiVirusResult/v5 | This API is used to query the virus scan result list. | |
| Querying Virus Scan Statistics | hcloud HSS ShowAntivirusStatistic/v5 | This API is used to query virus scan statistics. | |
| Creating a Virus Scan Task | hcloud HSS CreateAntiVirusTask/v5 | This API is used to create a virus scan task. | |
| Viewing the Virus Scan Task List | hcloud HSS ListAntiVirusTask/v5 | This API is used to view the virus scan task list. | |
| Canceling a Scan Task | hcloud HSS SwitchAntivirusTask/v5 | This API is used to cancel a scan task. |
Application Protection
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Application Protection Event List | hcloud HSS ListRaspEvents/v5 | This API is used to query the application protection event list. It retrieves the protection event information, including the alarm severity, server name, alarm name, alarm time, attack source IP address, and attack source URL. | |
| Querying the Protection Policy List | hcloud HSS ListRaspPolicies/v5 | This API is used to query the protection policy list. It queries the protection policy information, including the protection policy name, detection rule, and number of associated servers. | |
| Querying Protection Policy Details | hcloud HSS ShowRaspPolicyDetail/v5 | This API is used to query protection policy details. It queries the detection rules configured for a protection policy, including 14 types of detection rules. | |
| Deleting a Protection Policy | hcloud HSS DeletePolicy/v5 | This API is used to delete a protection policy. A protection policy in use cannot be deleted. | |
| Adding a Protection Policy | hcloud HSS AddPolicy/v5 | This API is used to add a protection policy. It specifies a protection policy, including the policy name, rule enabling status, protection action, and detection rule configuration. | |
| Modifying a Protection Policy | hcloud HSS UpdatePolicy/v5 | This API is used to modify a protection policy, including the policy name, rule status, protection action, and detection rule configuration; and to update the policy on servers where policy has been applied. | |
| Querying the Detection Rule List | hcloud HSS ListCheckFeatureRule/v5 | This API is used to query the detection rule list, including 14 detection rules. By default, all detection rules are disabled. | |
| Querying Java Applications of a Protected Server | hcloud HSS ShowRaspServerDetail/v5 | This API is used to query Java applications of a server. It queries the Java application status list of a server. | |
| Querying the List of Protected Servers | hcloud HSS ListProtectionServers/v5 | This API is used to query the protected server list. It queries the protected server data, including the server name, IP address, operating system, server group name, protection policy, protection status, microservice protection status, RASP protection status, and number of attacks prevented by RASP. | |
| Protection Data Statistics | hcloud HSS ShowRaspProtectStatistics/v5 | This API is used to collect protection data statistics, including the number of added protected servers and the number of microservice attacks blocked by RASP in the last seven days. | |
| Enable/Disable application protection and update the protection port. | hcloud HSS SwitchRasp/v5 | This API is used to enable or disable application protection, select the protection policy to be enabled, select the server to be protected, and deliver the protection policy. You can enter the port number to update the protection port. If protection is disabled, the policy is cleared. | |
| Querying the Status of Application Protection | hcloud HSS ShowAppRaspSwitchStatus/v5 | This API is used to query the status of application protection on a single server. |
Application Process Control
| API Name | Command | Description | Operation |
|---|---|---|---|
| Counting Servers with Unmatched Agent Versions | hcloud HSS ShowAppWhitelistAgentStatics/v5 | This API is used to count servers with unmatched agent versions. | |
| Querying Suspicious Processes in the Process Whitelist | hcloud HSS ListAppWhitelistEvent/v5 | This API is used to query suspicious processes in the process whitelist. | |
| Querying the Servers Available for the Process Whitelist | hcloud HSS ListAppWhitelistHostStatus/v5 | This API is used to query the servers available for the process whitelist. | |
| Querying the Servers Associated with a Process Whitelist Policy | hcloud HSS ListAppWhitelistPolicyHost/v5 | This API is used to query the servers associated with a process whitelist policy. | |
| Applying a Whitelist Policy | hcloud HSS SwitchAppWhitelistPolicyHost/v5 | This API is used to apply a whitelist policy. | |
| Querying Process Whitelist Policies | hcloud HSS ListAppWhitelistPolicy/v5 | This API is used to query process whitelist policies. | |
| Creating a Whitelist Policy | hcloud HSS CreateAppWhitelistPolicy/v5 | This API is used to create a whitelist policy. | |
| Modifying a Whitelist Policy | hcloud HSS ChangeAppWhitelistPolicy/v5 | This API is used to modify a whitelist policy. | |
| Deleting a Whitelist Policy | hcloud HSS DeleteAppWhitelistPolicy/v5 | This API is used to delete a whitelist policy. | |
| Querying Details About a Process Whitelist Policy | hcloud HSS ShowAppWhitelistPolicy/v5 | This API is used to query details about a process whitelist policy. | |
| Adding a Server to a Whitelist Policy | hcloud HSS AddAppWhitelistPolicyHost/v5 | This API is used to add a server to the whitelist policy. | |
| Deleting a Server from a Whitelist Policy | hcloud HSS DeleteAppWhitelistPolicyHost/v5 | This API is used to delete a server from a whitelist policy. | |
| Managing the Learning Status of a Process Whitelist Policy | hcloud HSS SwitchAppWhitelistPolicyLearnStatus/v5 | This API is used to manage the learning status of a process whitelist policy. | |
| Querying the Extended Process List of the Process Whitelist Policy | hcloud HSS ListAppWhitelistPolicyProcessExtend/v5 | This API is used to query the extended process list of the process whitelist policy. | |
| Querying the Processes Identified by the Process Whitelist Policy | hcloud HSS ListAppWhitelistPolicyProcess/v5 | This API is used to query the processes identified by the process whitelist policy. | |
| Adding a Process to the Whitelist Policy | hcloud HSS AddAppWhitelistPolicyProcess/v5 | This API is used to add a process to the process whitelist policy. | |
| Marking a Process Identified by the Process Whitelist Policy | hcloud HSS ChangeAppWhitelistPolicyProcessStatus/v5 | This API is used to mark a process identified by the process whitelist policy. |
Whitelist Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Alarm Whitelist | hcloud HSS ListAlarmWhiteList/v5 | This API is used to query the alarm whitelist. | |
| Deleting an Alarm Whitelist | hcloud HSS RemoveAlarmWhiteList/v5 | This API is used to delete an alarm whitelist. | |
| Querying the Login Whitelist | hcloud HSS ListLoginWhiteList/v5 | This API is used to query the login whitelist. | |
| Adding a Login Whitelist | hcloud HSS AddLoginWhiteList/v5 | This API is used to add a login whitelist. | |
| Deleting Whitelisted Login Items | hcloud HSS RemoveLoginWhiteList/v5 | This API is used to delete whitelisted login items. | |
| Querying System User Whitelist | hcloud HSS ListSystemUserWhiteList/v5 | This API is used to query the system user whitelist. | |
| Adding an Item to the System User Whitelist | hcloud HSS AddSystemUserWhiteList/v5 | This API is used to add an item to the system user whitelist. | |
| Modifying System User Whitelist | hcloud HSS UpdateSystemUserWhiteList/v5 | This API is used to modify the system user whitelist. | |
| Removing an Item from the System User Whitelist | hcloud HSS RemoveSystemUserWhiteList/v5 | This API is used to remove an item from the system user whitelist. |
File Integrity Monitoring
| API Name | Command | Description | Operation |
|---|---|---|---|
| Modifying the File List | hcloud HSS ListFileEvents/v5 | This API is used to modify the file list. | |
| Checking the New Server List | hcloud HSS ListFileHosts/v5 | This API is used to check the modified server list. | |
| Obtaining the File Statistics of a Server | hcloud HSS ShowFileStatistic/v5 | This API is used to obtain the file statistics of a server. | |
| Checking New File Information on a Server | hcloud HSS ListFileHostEventDetails/v5 | This API is used to check modified file information on a server. |
Container Installation and Configuration
| API Name | Command | Description | Operation |
|---|---|---|---|
| Batch Configuring Cluster Resources | hcloud HSS BatchUpdateClusterResource/v5 | This API is used to batch configure cluster resources. | |
| Uninstalling daemonset in batches | hcloud HSS BatchDeleteAgentDaemonset/v5 | This API is used to uninstall the cluster daemonset in batches. | |
| Upgrading Cluster Daemonset in Batches | hcloud HSS BatchUpgradeAgentDaemonset/v5 | This API is used to upgrade cluster daemonset in batches. | |
| Acquiring Cluster DaemonSet Lists | hcloud HSS ListAgentDaemonsetInfo/v5 | This API is used to obtain the cluster daemonset list. | |
| Obtaining Cluster Node Tags | hcloud HSS ListCceNodesLabel/v5 | This API is used to obtain cluster node tags. | |
| Deleting a Cluster Daemonset | hcloud HSS DeleteAgentDaemonset/v5 | This API is used to delete a cluster daemonset. | |
| Updating a Cluster Daemonset | hcloud HSS UpdateAgentDaemonset/v5 | This API is used to update a cluster daemonset. | |
| Obtaining Cluster Daemonset Information | hcloud HSS ShowAgentDaemonsetDetailInfo/v5 | This API is used to obtain cluster daemonset information. | |
| Creating a Cluster Daemonset | hcloud HSS CreateAgentDaemonset/v5 | This API is used to create a cluster daemonset. | |
| Obtaining Cluster Node Tags | hcloud HSS ListAgentDaemonsetClusterNodesLabel/v5 | This API is used to obtain cluster node tags. | |
| Configuring Public Network Access Settings | hcloud HSS ShowAgentAddress/v5 | This API is used to obtain network configuration information in public network access mode. | |
| Synchronizing the Access Status of a Multi-cloud Cluster | hcloud HSS SyncMultiCloudClusterStatus/v5 | This API is used to synchronize the access status of a multi-cloud cluster. | |
| Obtaining the Agent Installation Script of a Multi-Cloud Cluster | hcloud HSS ShowMultiCloudClusterProxyScript/v5 | This API is used to obtain the agent installation script of a multi-cloud cluster. | |
| Obtaining the Account Permissions of a Multi-cloud Cluster | hcloud HSS ShowMultiCloudClusterAuth/v5 | This API is used to obtain account permissions for a multi-cloud cluster. | |
| Deleting a Multi-cloud Cluster | hcloud HSS RemoveMultiCloudClusters/v5 | This API is used to delete a multi-cloud cluster. | |
| Updating a Multi-cloud Cluster | hcloud HSS UpdateMultiCloudClusters/v5 | This API is used to update a multi-cloud cluster. | |
| Querying a Multi-cloud Cluster | hcloud HSS ListMultiCloudClusters/v5 | This API is used to query multi-cloud clusters. | |
| Creating a Multi-cloud Cluster | hcloud HSS CreateMultiCloudClusters/v5 | This API is used to create a multi-cloud cluster. | |
| Parsing the Configuration File of a Multi-cloud Cluster | hcloud HSS ParseMultiCloudClusterConfig/v5 | This API is used to parse the configuration file of a multi-cloud cluster. | |
| Obtaining the Image Upload Command of a Multi-Cloud Cluster | hcloud HSS ShowMultiCloudClusterImageCommand/v5 | This API is used to obtain the image upload command of a multi-cloud cluster. | |
| Obtaining the Deployment Template | hcloud HSS ShowAgentDaemonsetDeployTemplate/v5 | This API is used to obtain the deployment template, which provides parameters for daemonset installation. | |
| Deleting CI/CD Configuration | hcloud HSS DeleteCicdConfigurations/v5 | This API is used to delete CI/CD configuration. | |
| Generating a CI/CD Access Configuration Command | hcloud HSS CreateCicdConfigurationCommand/v5 | This API is used to generate a CI/CD access configuration command. | |
| Querying CI/CD Configuration | hcloud HSS ShowCicdConfiguration/v5 | This API is used to query CI/CD configuration. | |
| Modifying CI/CD Configuration | hcloud HSS ModifyCicdConfiguration/v5 | This API is used to modify CI/CD configuration. | |
| Querying the CI/CD Configuration List | hcloud HSS ListCicdConfigurations/v5 | This API is used to query the CI/CD configuration list. | |
| Adding a CI/CD Configuration | hcloud HSS AddCicdConfiguration/v5 | This API is used to add a CI/CD configuration. | |
| Querying the CI/CD Image List | hcloud HSS ListCicdImages/v5 | This API is used to query the CI/CD image list. | |
| Obtaining Information About the Repository Associated with an Image Synchronization Task | hcloud HSS ListAssociateRegistries/v5 | This API is used to obtain information about the image repository associated with an image synchronization task. | |
| Deleting Image Repository Access Information in Batches | hcloud HSS BatchDeleteRegistry/v5 | This API is used to batch delete image repository access information. | |
| Obtaining the Image Upload Command of the Scan Component | hcloud HSS ShowImageUploadCommand/v5 | This API is used to obtain the image upload commands of the components required for image repository access and scanning. | |
| Querying the Statistics of an Image Repository | hcloud HSS ListRegistryStatistics/v5 | This API is used to query statistics of an image repository. | |
| Editing Image Repository Access Information | hcloud HSS UpdateRegistry/v5 | This API is used to edit image repository access information. | |
| Deleting Image Repository Access Information | hcloud HSS DeleteRegistry/v5 | This API is used to delete image repository access information. | |
| Adding an Image Repository | hcloud HSS AddRegistry/v5 | This API is used to add an image repository. | |
| Obtaining the Image Repository List | hcloud HSS ListRegistry/v5 | This API is used to obtain the image repository list. | |
| Creating a Task to Export All or Multiple Image Security Reports | hcloud HSS ExportImageSecurityReportTask/v5 | Create a task to export all or multiple image security reports. The malicious files, software information, file information, sensitive information, software compliance, and image building instruction risks can be exported. |
Dynamic Port Honeypot
| API Name | Command | Description | Operation |
|---|---|---|---|
| Checking Whether Auto-protection Is Enabled for New Servers by Default | hcloud HSS ShowDecoyPortAutoBind/v5 | This API is used to check whether auto-protection is enabled for new servers by default. | |
| Enabling Protection for New Servers by Default | hcloud HSS SwitchDecoyPortAutoBind/v5 | This API is used to enable protection for new servers by default. | |
| Viewing the List of Protected Servers | hcloud HSS ShowDecoyPortHostList/v5 | This API is used to view the list of protected servers. | |
| Switching the Dynamic Port Honeypot Policy of a Server | hcloud HSS SwitchDecoyPortHostPolicy/v5 | This API is used to switch the dynamic port honeypot policy of a server. | |
| Disabling the Dynamic Port Honeypot Policy of a Server | hcloud HSS DeleteDecoyPortHostPolicy/v5 | This API is used to disable the dynamic port honeypot policy of a server. | |
| Enabling Dynamic Port Honeypot Policies | hcloud HSS SwitchDecoyPortPolicy/v5 | This API is used to enable a dynamic port honeypot policy. | |
| Viewing a Dynamic Port Honeypot Policy | hcloud HSS ListDecoyPortPolicy/v5 | This API is used to view the dynamic port honeypot policy. | |
| Editing Dynamic Port Honeypot Policy | hcloud HSS ModifyDecoyPortPolicy/v5 | This API is used to edit a dynamic port honeypot policy. | |
| Viewing Dynamic Port Honeypot Policy Details | hcloud HSS ShowDecoyPortPolicyDetails/v5 | This API is used to view dynamic port honeypot policy details. | |
| Deleting a Dynamic Port Honeypot Policy | hcloud HSS DeleteDecoyPortPolicy/v5 | This API is used to delete a dynamic port honeypot policy. | |
| Adding a Dynamic Port Honeypot Policy | hcloud HSS CreateDecoyPortPolicy/v5 | This API is used to add a dynamic port honeypot policy. | |
| Viewing the List of Servers Supporting Dynamic Port Honeypots | hcloud HSS ListDecoyPortAvailableHost/v5 | This API is used to view the servers supporting dynamic port honeypots. |
Installation and Configuration
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Multi-Account List | hcloud HSS ListAccounts/v5 | This API is used to query the multi-account list. | |
| Deleting an Account | hcloud HSS DeleteAccount/v5 | This API is used to delete an account. | |
| Adding Accounts in Batches | hcloud HSS BatchAddAccounts/v5 | This API is used to add accounts in batches. | |
| Verifying Administrator Account Status | hcloud HSS ValidateAdmin/v5 | This API is used to check whether the current account is an administrator account (organization administrator or delegated administrator). | |
| Querying an Account Organization | hcloud HSS ListOrganizationTree/v5 | This API is used to query an account organization. | |
| Obtaining Trusted Service Statuses | hcloud HSS ListTrustServiceStatus/v5 | This API is used to retrieve the status of a trusted service. | |
| Enabling a Trusted Service | hcloud HSS EnableTrustService/v5 | This API is used to enable a trusted service. | |
| Querying the Agent Installation Script | hcloud HSS ListAgentInstallScript/v5 | This API is used to query the agent installation script. | |
| Obtaining the Docker Plug-in Installation Script | hcloud HSS ListPluginInstallScript/v5 | This API is used to obtain the Docker plug-in installation script. | |
| Querying the Status of the Sample Collection Configuration Switch for Malware Cloud Scans | hcloud HSS ListMalwareCollectStatus/v5 | This API is used to query the status of the sample collection configuration switch for malware cloud scans. | |
| Enabling or Disabling Malware Sample Collection for Cloud Scan | hcloud HSS ChangeMalwareCollectStatus/v5 | This API is used to enable or disable malware sample collection for cloud scans. | |
| Obtaining the Prompt Information Configuration | hcloud HSS ShowMalwareReminders/v5 | This API is used to obtain prompt information configuration settings. | |
| Configuring Prompt Information | hcloud HSS SetMalwareReminders/v5 | This API is used to configure prompt information. | |
| Obtaining Notifications on a Page | hcloud HSS ShowPageNotices/v5 | This API is used to obtain notifications on a page. | |
| Querying the Plug-in List | hcloud HSS ListDockerPlugins/v5 | This API is used to query the plug-in list. |
Plug-in Center
| API Name | Command | Description | Operation |
|---|---|---|---|
| Starting a Plugin | hcloud HSS StartPlugin/v5 | This API is used to start a plugin. | |
| Stopping a Plugin | hcloud HSS StopPlugin/v5 | This API is used to stop a plugin. | |
| Fetching Applied Plugin List | hcloud HSS ListPluginStatus/v5 | This API is used to fetch the applied plugin list. | |
| Retrieving Plugin Details | hcloud HSS ListPluginInfo/v5 | This API is used to retrieve plugin details. | |
| Querying the Plugin List | hcloud HSS ListPlugins/v5 | This API is used to query the plugin list. |
Cluster Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Number of Cluster Assets | hcloud HSS ShowClusterAssetStatistics/v5 | This API is used to query the number of cluster assets. | |
| Obtaining Some Prompt Information | hcloud HSS ListCommonTips/v5 | This API is used to obtain some prompt information. | |
| Synchronizing Cluster Protection Events | hcloud HSS SyncClusterProtectionEvent/v5 | This API is used to synchronize cluster protection events. | |
| Querying a Cluster Component Protection Policy Template | hcloud HSS ShowClusterProtectPolicyTemplate/v5 | This API is used to query a cluster protection policy template. | |
| Querying the Cluster Component Protection Policy Templates | hcloud HSS ListClusterProtectPolicyTemplates/v5 | This API is used to query the cluster protection policy templates. | |
| Querying the Audit Log List of the Kubernetes Cluster | hcloud HSS ListClusterAuditLogs/v5 | This API is used to query the audit log list of the Kubernetes cluster. | |
| Querying the Kubernetes Cluster Event List | hcloud HSS ListClusterEventLogs/v5 | This API is used to query the Kubernetes cluster event list. | |
| Obtaining Cluster Configurations | hcloud HSS ListCceClusterConfig/v5 | This API is used to query cluster configuration. | |
| Creating a CCE Integrated Protection Configuration | hcloud HSS AddCceIntegrationProtection/v5 | This API is used to create a CCE integrated protection configuration. | |
| Obtaining Container Cluster Risk Information in Batches | hcloud HSS ListCceClusterDetectRisk/v5 | This API is used to obtain container cluster risk information in batches. |
Cluster Risks
| API Name | Command | Description | Operation |
|---|---|---|---|
| Exporting Cluster Environment Security Information | hcloud HSS ExportRisks/v5 | This API is used to export cluster environment security information. | |
| Querying the List of Cluster Resources Affected by Cluster Risks | hcloud HSS ListClusterRiskAffectResources/v5 | This API is used to query the list of cluster resources affected by cluster risks. | |
| Querying the Cluster Risk List | hcloud HSS ListClusterRisks/v5 | This API is used to query the cluster risk list. | |
| Querying Cluster Scanning Statistics | hcloud HSS ShowClusterScanStatistics/v5 | This API is used to query cluster scanning statistics. |
Server Installation and Configuration
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Global Switch of a Specified Policy | hcloud HSS ShowPolicySwitchStatus/v5 | This API is used to query the global switch of a specified policy. | |
| Modifying the Global Switch of a Policy (to Enable/Disable the Policy for All Associated Servers) | hcloud HSS ChangePolicySwitchStatus/v5 | This API is used to modify the global switch of a policy to enable or disable it for all associated servers. | |
| Querying Agent Version List | hcloud HSS ListAgentVersion/v5 | This API is used to query the agent version list. | |
| Querying Alarm Configuration | hcloud HSS ListAlarmConfig/v5 | This API is used to query alarm configuration. | |
| Configuring Alarms | hcloud HSS UpdateAlarmConfig/v5 | This API is used to configure alarms. | |
| Querying the Status of the Automatic Agent Upgrade Function | hcloud HSS ListAgentAutoUpgradeStatus/v5 | This API is used to query the status of the automatic agent upgrade function. | |
| Enabling or Disabling the Automatic Agent Upgrade Function | hcloud HSS ChangeAgentAutoUpgradeStatus/v5 | This API is used to enable or disable the automatic agent upgrade function. | |
| Obtaining the Dictionary List | hcloud HSS ListDictionaries/v5 | This API is used to obtain the dictionary list. | |
| Querying Common Login IP Addresses | hcloud HSS ListLoginCommonIp/v5 | This API is used to query common login IP addresses. | |
| Adding, Editing, or Deleting a Common Login IP Address | hcloud HSS ModifyLoginCommonIp/v5 | This API is used to add, edit, or delete common login IP addresses. | |
| Querying Common Login Locations | hcloud HSS ListLoginCommonLocation/v5 | This API is used to query common login locations. | |
| Adding, Editing, or Deleting a Common Login Location | hcloud HSS ModifyLoginCommonLocation/v5 | This API is used to add, edit, or delete common login locations. | |
| Querying the SSH Login IP Address Whitelist | hcloud HSS ListLoginWhiteIp/v5 | This API is used to query the SSH login IP address whitelist. | |
| Managing Login IP Addresses | hcloud HSS ModifyLoginWhiteIp/v5 | This API is used to add, delete, edit, enable, or disable login IP addresses. | |
| Downloading a Script File | hcloud HSS ShowScriptFile/v5 | This API is used to download a script file. | |
| Obtaining the Configuration Switch Status | hcloud HSS ShowSwitchesStatus/v5 | This API is used to obtain the configuration switch status. | |
| Modifying the Configuration Switch Status | hcloud HSS ChangeSwitchesStatus/v5 | This API is used to modify the configuration switch status. | |
| Querying the System Configuration List | hcloud HSS ListSystemConfigs/v5 | This API is used to query the system configuration list. | |
| Configuring Two-Factor Login | hcloud HSS SetTwoFactorLoginConfig/v5 | This API is used to configure two-factor login. | |
| Querying the Two-Factor Server List | hcloud HSS ListTwoFactorLoginHost/v5 | This API is used to query the two-factor server list. | |
| Querying the Automatic Isolation and Killing Status of a Program | hcloud HSS ListAutoKillVirusStatus/v5 | This API is used to query the automatic isolation and killing status of a program. | |
| Enabling or Disabling Automatic Isolation and Killing of Malicious Programs | hcloud HSS StartAutoKillVirusStatus/v5 | This API is used to enable or disable automatic isolation and killing of malicious programs. |
Common Modules
| API Name | Command | Description | Operation |
|---|---|---|---|
| Saving User Access Records | hcloud HSS SaveBrowsingHistory/v5 | This API is used to save user access records. | |
| Querying Project Configurations | hcloud HSS ListProjectConfigs/v5 | This API is used to query project configurations. | |
| Modifying Project Configurations | hcloud HSS ModifyProjectConfigs/v5 | This API is used to modify project configurations. | |
| Uploading a Security Report Logo | hcloud HSS UploadReportLogo/v5 | This API is used to upload a security report logo. |
IaC Risks
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining the Risk Path List of IAC Files | hcloud HSS ListIacFileRiskPaths/v5 | This API is used to obtain the risk path list of IAC files. | |
| Obtaining the Risk List of the IAC File | hcloud HSS ListIacFileRisks/v5 | This API is used to obtain the risk list of the IAC file. | |
| Obtaining the IAC File List | hcloud HSS ListIacFiles/v5 | This API is used to obtain the IAC file list. |
Common Service Modules
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Task Statistics | hcloud HSS ShowTaskStatistics/v5 | This API is used to query task statistics. | |
| Creating a Task | hcloud HSS CreateTask/v5 | This API is used to create a task. | |
| Obtaining Jobs | hcloud HSS ListTasks/v5 | This API is used to obtain the job list. | |
| Querying the Resource List Associated with the Current Task | hcloud HSS ListTaskResources/v5 | This API is used to query the resource list associated with the current task. | |
| Restarting Tasks | hcloud HSS RetryTask/v5 | This API is used to re-run a task. |
Container Images
| API Name | Command | Description | Operation |
|---|---|---|---|
| Listing Resources Affected by a Configuration Check Item | hcloud HSS ListCheckRuleResources/v5 | This API is used to list resources affected by a configuration check item. | |
| Obtaining Baseline Check Configuration Information | hcloud HSS ListCheckRulesInfo/v5 | This API is used to obtain baseline check configuration information. | |
| Querying Container Image Operation Logs | hcloud HSS ListContainerImageLogs/v5 | This API is used to query container image operation logs. | |
| Querying the Container Image List | hcloud HSS ListContainerImages/v5 | This API is used to query the container image list. | |
| Obtaining Image Software Information | hcloud HSS ListGlobalImageApps/v5 | This API is used to obtain software information from an image. | |
| Container Assets - Image Statistics | hcloud HSS ShowImageAssetStatistics/v5 | Container Assets - Image Statistics | |
| Querying the Mirror Configuration Check Report | hcloud HSS ShowImageCheckRuleDetail/v5 | This API is used to query the mirror configuration check report. | |
| Exporting Baseline Check Results of Image Repositories in Batches (Full Export Supported) | hcloud HSS BatchExportBaselineTask/v5 | This API is used to export baseline checks for multiple image repositories (full exports supported). When exporting data for CI/CD images, set image_type as 'cicd'. | |
| Querying Custom Weak Passwords of Images | hcloud HSS ShowExtendedWeakPassword/v5 | This API is used to search for custom weak passwords associated with an image. | |
| Updating Custom Weak Passwords for Images | hcloud HSS ChangeExtendedWeakPassword/v5 | This API is used to change the user-defined weak password of an image. | |
| Querying Image Password Complexity Policy Check Reports | hcloud HSS ListImagePwdComplexity/v5 | This API is used to generate reports on password complexity policy detection for images. Identify CI/CD images by speciying their type and ID. For other types of repositories, specify other parameters like organization name, image name, and version. | |
| Querying the Check Item List of a Specified Security Configuration Item of an Image | hcloud HSS ListImageRiskConfigRules/v5 | This API is used to query the check item list of a specified security configuration item of an image. | |
| Querying the List of Image Security Configuration Detection Results | hcloud HSS ListImageRiskConfigs/v5 | Query the image security configuration check result list. Supported check items include the system configuration items and SSH application configuration items of CentOS 7, Debian 10, EulerOS, and Ubuntu 16 images. | |
| Querying the Statistics of Baseline Checks | hcloud HSS ShowImageBaselineStatistic/v5 | Query the baseline check statistics, including weak passwords, password complexity, and configuration checks. To query the statistics of a single CI/CD image, you need to specify image_type and image_id parameters. To query the statistics of a single repository image, you need to specify the image_type, organization name, image name, and image version. | |
| Querying Lists of Weak Password Check Results of Images | hcloud HSS ListImageWeakPwdUsers/v5 | This API is used to list the results of weak passwords checks. Identify CI/CD images by speciying their type and ID. For other types of repositories, specify other parameters like organization name, image name, and version. | |
| Scanning Images in the Image Repository in Batches (Deprecated) | hcloud HSS BatchScanSwrImage/v5 | This API is used to scan images in the image repository in batches. (Deprecated) | |
| Listing Images Impacted by Build Commands | hcloud HSS ListImageBuildCommandRisksImages/v5 | This API is used to query the list of images affected by the image build command. | |
| Assessing Image Build Command Risks | hcloud HSS ListImageBuildCommandRisks/v5 | This API is used to obtain risk information about an image build command. | |
| Obtaining Image File Information | hcloud HSS ListGlobalImageFiles/v5 | This API is used to retrieve image file information. | |
| Querying the Local Image List | hcloud HSS ListImageLocal/v5 | This API is used to query the local image list. | |
| Exporting Vulnerabilities of Local Images in Batches (Full Export Supported) | hcloud HSS BatchExportLocalVulTask/v5 | This API is used to batch export vulnerabilities from local images. (Full export is supported.) | |
| Querying Software Information of Local Images | hcloud HSS ListLocalImageAppInfo/v5 | This API is used to query software information of local images. | |
| Performing Local Image Scans | hcloud HSS BatchScanLocalImage/v5 | This API is used to scan local images. | |
| Querying Container Information of Local Images | hcloud HSS ListLocalImageContainers/v5 | This API is used to query container information of local images. | |
| Querying Host Information of Local Images | hcloud HSS ListLocalImageHosts/v5 | This API is used to query server information of local images. | |
| Querying the List of Malicious Files of Tenants | hcloud HSS ListGlobalMalware/v5 | This API is used to query tenant malicious files. | |
| Exporting Image Security Report Statistics | hcloud HSS ShowImageSecurityReportStatistic/v5 | This API is used to export image security report statistics. | |
| Querying Sensitive Information of Images | hcloud HSS ListImageSensitiveInfo/v5 | This API is used to query sensitive information of images. | |
| Querying Whitelist of Sensitive Information File Paths of an Image | hcloud HSS ShowFilePathWhiteLists/v5 | Query the whitelist of sensitive information file paths of an image. | |
| Modifying Whitelist of Sensitive Information File Paths of an Image | hcloud HSS ChangeFilePathWhiteLists/v5 | Modify the whitelist of sensitive information file paths of an image. | |
| Querying Whitelist of Sensitive Information File Paths of an Image (Deprecated) | hcloud HSS ShowFilePathWhiteDetail/v5 | Query the whitelist of sensitive information file paths of an image. (This API has been deprecated.) | |
| Modifying Whitelist of Sensitive Information File Paths of an Image (Deprecated) | hcloud HSS ChangeFilePathWhiteDetail/v5 | Modify the whitelist of sensitive information file paths of an image. (This API has been deprecated.) | |
| Handling Sensitive Information Operations | hcloud HSS ChangeSensitiveInfo/v5 | This API is used to handle sensitive information operations. | |
| Querying the Image List of the SWR Image Repository (Deprecated) | hcloud HSS ListSwrImageRepository/v5 | This API is used to query the image list in the SWR image repository. To synchronize the latest images from SWR, call the API for synchronizing images from SWR first. | |
| Synchronizing Image List from the SWR (Deprecated) | hcloud HSS RunImageSynchronize/v5 | Synchronize the image list from the SWR. (This API has been deprecated.) | |
| Retrieving User Vulnerability Data | hcloud HSS ListGlobalVulnerabilities/v5 | This API is used to query user vulnerability information. | |
| Querying the List of Vulnerabilities Affected by Image Vulnerability Handling Operations | hcloud HSS ListImageHandleAffectVulnerabilities/v5 | This API is used to query the list of vulnerabilities affected by image vulnerability handling operations. | |
| Handling Image Vulnerabilities | hcloud HSS HandleImageVulnerability/v5 | This API is used to handle image vulnerabilities. | |
| Viewing the Software of the Images Affected by a Vulnerability | hcloud HSS ListVulAffectImageApps/v5 | This API is used to view the software information of the images affected by a vulnerability. | |
| Viewing the Containers Associated with the Images Affected by a Vulnerability | hcloud HSS ListVulAffectImageContainers/v5 | This API is used to view the containers associated with the images affected by a vulnerability. | |
| CVE Information Corresponding to the Vulnerability | hcloud HSS ListVulnerabilityCve/v5 | This API is used to query the CVE information corresponding to the vulnerability. | |
| Querying Details About an Image Whitelist | hcloud HSS ShowImageWhiteListDetail/v5 | This API is used to query details about the image whitelist. The list of images associated with the whitelist needs to be queried by page. | |
| Modifying the Image Whitelist Configuration | hcloud HSS ChangeImageWhiteList/v5 | This API is used to modify the image whitelist configuration. | |
| Querying the Image Whitelist | hcloud HSS ListImageWhiteLists/v5 | This API is used to query the image whitelist. Currently, only the vulnerability whitelist is supported. | |
| Adding an Image to the Whitelist | hcloud HSS AddImageWhiteLists/v5 | This API is used to add an image to the whitelist. Currently, only the vulnerability whitelist is supported. | |
| Deleting an Image from the Whitelist | hcloud HSS DeleteImageWhiteLists/v5 | This API is used to delete an image from the whitelist. | |
| Query the Image Software List | hcloud HSS ListImageApps/v5 | This API is used to query the image software list. For a CI/CD image, only the image_id parameter needs to be specified. The organization name, image name, and image tag are not required. For other image types, the organization name, image name, and image tag are mandatory. | |
| Querying Basic Image Information | hcloud HSS ListImageBasicImage/v5 | This API is used to query the basic image information. For a CI/CD image, its image type and image ID should be specified to uniquely identify the image. For a repository image, its image type, organization name, image name, and image tag should be specified to uniquely identify the image. | |
| Querying Image File Statistics | hcloud HSS ShowImageFilesStat/v5 | This API is used to query the image file statistics. For a CI/CD image, only the image_id parameter needs to be specified. The organization name, image name, and image tag are not required. For other image types, the organization name, image name, and image tag are mandatory. | |
| Querying the Image File List | hcloud HSS ListImageFiles/v5 | This API is used to query the image file list. For a CI/CD image, only the image_id parameter needs to be specified. The organization name, image name, and image tag are not required. For other image types, the organization name, image name, and image tag are mandatory. | |
| Querying the List of Malicious Files in Images | hcloud HSS ListImageMalware/v5 | This API is used to query the list of malicious files in an image. If the image is of the CI/CD type, only the image ID needs to be specified; organization name, image name, and version are not required. For other types of images, organization name, image name, and version must be provided. | |
| Querying the List of Non-Compliant Software in Images | hcloud HSS ListImageNonCompliantApp/v5 | This API is used to retrieve non-compliant software information for an image. For CI/CD images, specify the image type and ID to uniquely identify it. For other repository types, provide the image type, organization name, image name, and version to pinpoint the specific image. | |
| Obtaining Sensitive Information of an Image | hcloud HSS ListImageSensitive/v5 | This API is used to check sensitive information within an image. To locate a CI/CD image, input its type and ID. For other repositories, specify the image type along with the organization name, image name, and version to find the exact match. | |
| Querying Image Vulnerability Information | hcloud HSS ListImageVulnerabilities/v5 | This API is used to query image vulnerability information. | |
| Information About the Images Affected by Vulnerabilities | hcloud HSS ListVulRepoImage/v5 | This API is used to fetch details about which images in a repository are affected by a vulnerability. | |
| Viewing the List of Images Affected by the Vulnerability | hcloud HSS ListVulAffectImages/v5 | This API is used to view the list of images affected by vulnerabilities. |
Image Scan Task
| API Name | Command | Description | Operation |
|---|---|---|---|
| Terminating a Repository Image Scan Task | hcloud HSS StopImageScanTask/v5 | This API is used to terminate an image scan task in the repository. | |
| Creating a Scan Task | hcloud HSS CreateManualImageScanTask/v5 | This API is used to create a scan job. | |
| Querying Pay-per-use Image Scans Statistics | hcloud HSS ShowImagePayPerScanStatistics/v5 | This API is used to query pay-per-use scan statistics for images. | |
| Obtaining Scan Policies | hcloud HSS ListImageScanPolicy/v5 | This API is used to obtain scan policies. | |
| Modifying a Periodic Scan Policy | hcloud HSS ModifyImageScanPolicy/v5 | This API is used to modify a periodic scan policy. | |
| Obtaining the Scan Task List | hcloud HSS ListImageScanTask/v5 | This API is used to obtain the scan task list. |
Repository image
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating an Image Synchronization Task | hcloud HSS CreateImageSynchronizeTask/v5 | This API is used to create an image synchronization task. | |
| Querying the Image List of a Repository | hcloud HSS ListRegistryImages/v5 | This API is used to query the image list of a repository. |
Security Operations
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of Historical Virus Scan Records | hcloud HSS ListAntivirusHandleHistory/v5 | This API is used to query the list of historical virus scan records. | |
| Querying the List of Historical Alarm Records | hcloud HSS ListEventHandleHistory/v5 | This API is used to query the list of historical alarm records | |
| Querying Scheduled Security Check Configuration | hcloud HSS ShowSecurityCheckConfig/v5 | This API is used to query the scheduled configuration of a security check. | |
| Modifying Scheduled Security Check Configuration | hcloud HSS UpdateSecurityCheckConfig/v5 | This API is used to modify the scheduled configuration of a security check. | |
| Querying the Security Check Report Information of a Cluster | hcloud HSS ShowSecurityCheckClusterReport/v5 | This API is used to query the security check report information of a cluster. | |
| Querying the Security Check Report List of a Cluster | hcloud HSS ListSecurityCheckClusterReports/v5 | This API is used to query the security check report list of a cluster. | |
| Querying the Security Check Report of a Specified Server | hcloud HSS ShowSecurityCheckHostReport/v5 | This API is used to query the security check report of a specified server. | |
| Manually Start a Health Check | hcloud HSS StartManualSecurityCheck/v5 | This API is used to manually start a health check. | |
| Querying the Status and Progress of a Manual Health Check | hcloud HSS ShowManualSecurityCheckStatus/v5 | This API is used to query the status and progress of a manual health check. | |
| Cancelling a Manual Health Check | hcloud HSS StopManualSecurityCheck/v5 | This API is used to cancel a manual health check. | |
| Viewing Vulnerability Handling History | hcloud HSS ListVulHandleHistory/v5 | This API is used to query vulnerability handling history. |
Dashboard
| API Name | Command | Description | Operation |
|---|---|---|---|
| Exporting a Monthly Operations Summary Report | hcloud HSS ExportTaskInfo/v5 | This API is used to export a monthly operations summary report. | |
| Querying the Status of a User's Monthly Operations Dialog Box | hcloud HSS ShowMonthlyOperaReportNotifyInfo/v5 | This API is used to query the status of a user's monthly operations dialog box. | |
| Changing the Status of a User's Monthly Operations Dialog Box | hcloud HSS ChangeMonthlyOperationReportTipStatus/v5 | This API is used to change the status of a user's monthly operations dialog box. | |
| Querying the Details of a Monthly Operations Report | hcloud HSS ShowMonthlyOperationReportDetail/v5 | This API is used to query the details of a monthly operations report. | |
| Querying the Monthly Operations Report List | hcloud HSS ListMonthlyOperationReports/v5 | This API is used to query the monthly operations report list. | |
| Querying the Information in the News and Promotions Area of a Monthly Operations Report | hcloud HSS ShowWelfareAreaInfo/v5 | This API is used to query the information in the news and promotions area of a monthly operations report. | |
| Querying the Number of Agents | hcloud HSS ShowAgentStatistics/v5 | This API is used to query the number of agents to be upgraded, online agents, and offline agents. | |
| Hot News | hcloud HSS ShowHotInformation/v5 | This API returns the title, update time, and information level. | |
| Querying the Protection Period, Virus Database Update Time, Vulnerability Database Update Time, and Accumulated Number of Records of Each Module | hcloud HSS ShowProtectStatistics/v5 | This API is used to query the protection period, virus database update time, vulnerability database update time, and accumulated number of records of each module. | |
| Querying Risk Score | hcloud HSS ShowRiskScore/v5 | This API is used to query the risk score. | |
| Querying the Security Risk List | hcloud HSS ListSecurityRisk/v5 | This API is used to query the security risk list. |
Security Reports
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List on the Report Overview Page | hcloud HSS ListSecurityReport/v5 | This API is used to query the list on the report overview page. | |
| Sending a Security Report | hcloud HSS SendSecurityReport/v5 | This API is used to send security reports. |
These APIs are used for serverless asset management.
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Details about a Serverless Asset (Deprecated) | hcloud HSS ListServerlessAssetDetail/v5 | This API is used to query details about a serverless asset. (This API has been deprecated.) | |
| Querying Serverless Asset List (Deprecated) | hcloud HSS ListServerlessAsset/v5 | This API is used to query the serverless asset list. (This API has been deprecated.) |
Custom Protection Rules
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Details About a Custom Rule | hcloud HSS ListCustomRuleConfigDetail/v5 | This API is used to query details about a custom rule. | |
| Enabling or Disabling a Custom Rule | hcloud HSS ResumePauseCustomRuleConfig/v5 | This API is used to enable or disable a custom rule. | |
| Creating a Custom Rule | hcloud HSS CreateCustomRuleConfig/v5 | This API is used to create a custom rule. | |
| Querying the Custom Rule List | hcloud HSS ListCustomRuleConfigs/v5 | This API is used to query the custom rule list. | |
| Modifying a Custom Rule | hcloud HSS UpdateCustomRuleConfig/v5 | This API is used to modify a custom rule. | |
| Deleting a Custom Rule | hcloud HSS DeleteCustomRuleConfig/v5 | This API is used to delete a custom rule. |
Protection configuration
| API Name | Command | Description | Operation |
|---|---|---|---|
| ID of the policy bound to the agent. Currently, this parameter is supported only in CN Southwest-Guiyang1. | hcloud HSS BindAgentPolicy/v5 | ID of the policy bound to the agent. | |
| Querying Policy Details, Only CN Southwest-Guiyang1 Is Supported | hcloud HSS ListAiPolicyDetail/v5 | This API is used to query policy details. | |
| Modifying Policy Details, Only CN Southwest-Guiyang1 Is Supported | hcloud HSS UpdateAiPolicyDetail/v5 | This API is used to modify policy details. This API is complex and you are not advised to call it. You are advised to modify policy details on the Huawei Cloud console. | |
| Enabling or Disabling a Policy Group, Only CN Southwest-Guiyang1 Is Supported | hcloud HSS ResumePauseAiPolicyGroups/v5 | This API is used to enable or disable a policy group. | |
| Querying the Policy Group List, Only CN Southwest-Guiyang1 Is Supported | hcloud HSS ListAiPolicyGroups/v5 | This API is used to query the policy group list. | |
| Copying a Policy Group, Only CN Southwest-Guiyang1 Is Supported | hcloud HSS CopyAiPolicyGroup/v5 | This API is used to copy a policy group. | |
| Deleting a Policy Group, Only CN Southwest-Guiyang1 Is Supported | hcloud HSS DeleteAiPolicyGroups/v5 | Delete a policy group. | |
| Enabling or Disabling a Policy, Only CN Southwest-Guiyang1 Is Supported | hcloud HSS ResumePauseAiPolicies/v5 | This API is used to enable or disable a policy. | |
| Querying the Policy List, Only CN Southwest-Guiyang1 Is Supported | hcloud HSS ListAiPolicies/v5 | This API is used to query the policy list. |
Asset discovery.
| API Name | Command | Description | Operation |
|---|---|---|---|
| Modifying the Open Port Status | hcloud HSS BatchModifyPortStatus/v5 | This API is used to modify the open port status. |
Cluster Protection
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Cluster Protection Information | hcloud HSS ListClusterProtectionInfo/v5 | This API is used to query cluster protection information. | |
| Obtaining the List of Default Cluster Protection Policies | hcloud HSS ListClusterProtectionDefaultPolicy/v5 | This API is used to obtain the list of default cluster protection policies. | |
| Obtaining Alarm Events in All Clusters | hcloud HSS ListClusterEvents/v5 | This API is used to obtain alarm events in all clusters. | |
| Modifying the Alarm Status | hcloud HSS ChangeClusterEvents/v5 | This API is used to modify the alarm status. | |
| Cluster Protection Overview | hcloud HSS ListClusterProtectOverview/v5 | This API is used to obtain cluster protection overview. | |
| Viewing Details About a Specified Policy | hcloud HSS ListClusterProtectionPolicyDetail/v5 | This API is used to view details about a specified policy. | |
| Deleting a Cluster Protection Policy | hcloud HSS DeleteClusterProtectionPolicy/v5 | This API is used to delete a cluster protection policy. | |
| Obtaining the Cluster Protection Policies | hcloud HSS ListClusterProtectionPolicy/v5 | This API is used to obtain the cluster protection policies. | |
| Creating a Cluster Protection Policy | hcloud HSS CreateClusterProtectionPolicy/v5 | This API is used to create a cluster protection policy. | |
| Modifying a Cluster Protection Policy | hcloud HSS ChangeClusterProtectionPolicy/v5 | This API is used to modify a cluster protection policy. | |
| Obtaining All the Protection Items of a Cluster | hcloud HSS ListClusterProtectionItem/v5 | This API is used to obtain all the protection items of a cluster. | |
| Performing Operations on Cluster Protection | hcloud HSS SwitchClusterProtectionMode/v5 | This API is used to perform operations on cluster protection. |
Container Network Isolation Information
| API Name | Command | Description | Operation |
|---|---|---|---|
| Synchronizing the latest data of a container cluster | hcloud HSS SyncClusterList/v5 | This API is used to synchronize the latest data of a container cluster. | |
| Querying Clusters Protected by Container Security | hcloud HSS ListContainerNetworkClusters/v5 | This API is used to query clusters protected by container security. | |
| Cluster Network Policy Overview | hcloud HSS ShowNetworkStatistics/v5 | This API is used to obtain cluster network policy overview. | |
| Querying All Security Groups in an Enterprise Project | hcloud HSS ListSecurityGroups/v5 | This API is used to query all security groups in an enterprise project. | |
| Obtaining Namespaces in a Cluster | hcloud HSS ListNamespaces/v5 | This API is used to obtain namespaces in a cluster. | |
| Querying the Network Information of a Container Cluster | hcloud HSS ShowContainerNetworkInfo/v5 | This API is used to query the network information of a container cluster. | |
| Synchronizing the Latest Data of Network Nodes in a Cluster | hcloud HSS SyncContainerNetworkNode/v5 | This API is used to synchronize the latest container network policies from a cluster. | |
| Querying the Node List of a Container Cluster VPC Network | hcloud HSS ListContainerNetworkNodeList/v5 | This API is used to query the node list of a container cluster network. | |
| Synchronizing the Latest Container Network Policies from a Cluster | hcloud HSS SyncContainerNetworkPolicyList/v5 | This API is used to synchronize the latest container network policies from a cluster. | |
| Querying the List of Container Cluster Network Policies | hcloud HSS ListContainerNetworkPolicy/v5 | This API is used to query the list of container cluster network policies. | |
| Delete The Container Cluster Network Configuration Policy | hcloud HSS DeleteContainerNetworkPolicy/v5 | This API is used to delete the container cluster network configuration policy. | |
| Configuration Policy for Adding a Network to a Container Cluster | hcloud HSS CreateContainerNetworkPolicy/v5 | This API is used to configure the policy for adding a network to a container cluster. | |
| Container Cluster Network Update Configuration Policy | hcloud HSS UpdateContainerNetworkPolicy/v5 | This API is used to configure the container cluster network update policy. | |
| Querying the Security Group Policies Configured for Clusters Using Cloud Native Network Mode 2.0 | hcloud HSS ListSecurityGroupPolicies/v5 | This API is used to query the security group policies configured for a cluster in cloud native network mode 2.0. | |
| Synchronizing the Latest Security Group Policies in a Cluster | hcloud HSS SyncSecurityGroupPolicies/v5 | This API is used to synchronize the latest security group policies in a cluster. | |
| Deleting a Security Group Policy | hcloud HSS DeleteSecurityGroupPolicy/v5 | This API is used to delete a security group policy (for the cloud native network model). | |
| Creating a Security Group Policy | hcloud HSS CreateSecurityGroupPolicy/v5 | This API is used to create a security group policy (for the cloud native network model). | |
| Updating a Security Group Policy | hcloud HSS UpdateSecurityGroupPolicy/v5 | This API is used to update a security group policy (for the cloud native network model). | |
| Querying the Workloads in a Namespace in a Cluster | hcloud HSS ListWorkLoads/v5 | This API is used to query the workloads in a namespace in a cluster. |
Event management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Supported Event Processing Types | hcloud HSS ListEventOperates/v5 | This API is used to query supported event processing types. | |
| Handling All Alarms | hcloud HSS BatchChangeEvent/v5 | This API is used to handle all alarms. | |
| Querying the List of Duplicate Alarms for Alarm Events | hcloud HSS ListSameEvents/v5 | This API is used to query similar alarms related to a specific alarm. | |
| Querying the Threat Level Statistics List | hcloud HSS ShowEventSeverity/v5 | This API is used to query threat level statistics. | |
| Querying the List of Handled Similar Alarms Associated with an Alarm Event | hcloud HSS ListSimilarHandledEvents/v5 | This API is used to query similar handled alarms related to a specific alarm. | |
| Querying the Top 5 Event Type Statistics (Deprecated) | hcloud HSS ListEventTopRisk/v5 | This API is used to query top 5 event type statistics. (Deprecated) |
event
| API Name | Command | Description | Operation |
|---|---|---|---|
| Editing the Host for Which the Alarm Whitelist Takes Effect | hcloud HSS UpdateAlarmWhiteListHost/v5 | This API is used to edit information about hosts in the alarm whitelist. | |
| Querying Details About an Alarm Whitelist | hcloud HSS ListAlarmWhiteListHostDetail/v5 | This API is used to query alarm whitelist details. |
Container Assets
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Basic CronJobs Information List | hcloud HSS ListK8sCronJobs/v5 | This API is used to query the basic cronjobs information list. | |
| Querying the Basic DaemonSets Information List | hcloud HSS ListK8sDaemonSets/v5 | This API is used to query the basic information list of daemonsets. | |
| Querying Basic Deployment Information | hcloud HSS ListK8sDeployments/v5 | This API is used to query basic deployment information. | |
| Querying the Basic Job Information List | hcloud HSS ListK8sJobs/v5 | This API is used to query the basic job information list. | |
| Querying the Basic StatefulSet Information List | hcloud HSS ListK8sStatefulSets/v5 | This API is used to query the basic statefulset information list. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot