doc-exports/docs/hss/api-ref/CLASS.TXT.json
Li, Qiao a5e72d5590 HSS API 20240206 version
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>
2024-05-28 20:54:21 +00:00

551 lines
22 KiB
JSON

[
{
"desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ",
"product_code":"hss",
"title":"API Usage Guidelines",
"uri":"hss_02_0001.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"API Description",
"uri":"hss_02_0011.html",
"doc_type":"api",
"p_code":"",
"code":"2"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Asset Management",
"uri":"topic_300000000.html",
"doc_type":"api",
"p_code":"2",
"code":"3"
},
{
"desc":"This API is used to collect statistics on assets, such as accounts, ports, and processes.GET /v5/{project_id}/asset/statisticsStatus code: 200This API is used to query th",
"product_code":"hss",
"title":"Collecting Asset Statistics, Including Accounts, Ports, and Processes",
"uri":"ShowAssetStatistic.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"desc":"This API is used to check account information in asset fingerprints.GET /v5/{project_id}/asset/user/statisticsStatus code: 200The first 10 accounts are queried by default",
"product_code":"hss",
"title":"Asset Fingerprint - Account Information",
"uri":"ListUserStatistics.html",
"doc_type":"api",
"p_code":"3",
"code":"5"
},
{
"desc":"This API is used to check process information in asset fingerprints.GET /v5/{project_id}/asset/process/statisticsStatus code: 200The first 10 processes whose type is host",
"product_code":"hss",
"title":"Asset Fingerprint - Process Information",
"uri":"ListProcessStatistics.html",
"doc_type":"api",
"p_code":"3",
"code":"6"
},
{
"desc":"This API is used to check software information in asset fingerprints.GET /v5/{project_id}/asset/app/statisticsStatus code: 200The first 10 software lists whose type is ho",
"product_code":"hss",
"title":"Asset Fingerprint - Software Information",
"uri":"ListAppStatistics.html",
"doc_type":"api",
"p_code":"3",
"code":"7"
},
{
"desc":"This API is used to check auto-started items in asset fingerprints.GET /v5/{project_id}/asset/auto-launch/statisticsStatus code: 200The first 10 auto-startup items are qu",
"product_code":"hss",
"title":"Asset Fingerprint - Auto-Started Item Information",
"uri":"ListAutoLaunchStatistics.html",
"doc_type":"api",
"p_code":"3",
"code":"8"
},
{
"desc":"This API is used to query the server list of an account.GET /v5/{project_id}/asset/usersStatus code: 200Query servers list whose account is daemon by default.Status code:",
"product_code":"hss",
"title":"Querying the Server List of an Account",
"uri":"ListUsers.html",
"doc_type":"api",
"p_code":"3",
"code":"9"
},
{
"desc":"This API is used to check open port information in the asset fingerprints of a server.GET /v5/{project_id}/asset/portsStatus code: 200The first 10 open ports whose host_i",
"product_code":"hss",
"title":"Asset Fingerprint of a Server - Open Port Information",
"uri":"ListPorts.html",
"doc_type":"api",
"p_code":"3",
"code":"10"
},
{
"desc":"This API is used to check software information in the asset fingerprints of a server.GET /v5/{project_id}/asset/appsStatus code: 200The first 10 servers whose software na",
"product_code":"hss",
"title":"Asset Fingerprint of a Server - Software",
"uri":"ListApps.html",
"doc_type":"api",
"p_code":"3",
"code":"11"
},
{
"desc":"This API is used to check auto-started items in the asset fingerprints of a server.GET /v5/{project_id}/asset/auto-launchsStatus code: 200The first 10 services whose auto",
"product_code":"hss",
"title":"Asset Fingerprint of a Server - Auto-Started Items",
"uri":"ListAutoLaunchs.html",
"doc_type":"api",
"p_code":"3",
"code":"12"
},
{
"desc":"This API is used to obtain the account change history.GET /v5/{project_id}/asset/user/change-historyStatus code: 200The first 10 account change records whose start time i",
"product_code":"hss",
"title":"Obtaining the Account Change History",
"uri":"ListUserChangeHistories.html",
"doc_type":"api",
"p_code":"3",
"code":"13"
},
{
"desc":"This API is used to check the change history of software in the asset fingerprints of a server.GET /v5/{project_id}/asset/app/change-historyStatus code: 200The first 10 s",
"product_code":"hss",
"title":"Asset Fingerprint - Software Information - Change History",
"uri":"ListAppChangeHistories.html",
"doc_type":"api",
"p_code":"3",
"code":"14"
},
{
"desc":"This API is used to check open port information in asset fingerprints.GET /v5/{project_id}/asset/port/statisticsStatus code: 200The first 10 open ports whose port number ",
"product_code":"hss",
"title":"Asset Fingerprint - Open Port Information",
"uri":"ListPortStatistics.html",
"doc_type":"api",
"p_code":"3",
"code":"15"
},
{
"desc":"This API is used to check the change history of auto-started items in the asset fingerprints of a server.GET /v5/{project_id}/asset/auto-launch/change-historyStatus code:",
"product_code":"hss",
"title":"Asset Fingerprint - Auto-started Item - Change History",
"uri":"ListAutoLaunchChangeHistories.html",
"doc_type":"api",
"p_code":"3",
"code":"16"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Ransomware Prevention",
"uri":"topic_300000001.html",
"doc_type":"api",
"p_code":"2",
"code":"17"
},
{
"desc":"This API is used to query the protection policy list of ransomware.GET /v5/{project_id}/ransomware/protection/policyStatus code: 200Query the protection policy list of ra",
"product_code":"hss",
"title":"Querying the Protection Policy List of Ransomware",
"uri":"ListProtectionPolicy.html",
"doc_type":"api",
"p_code":"17",
"code":"18"
},
{
"desc":"This API is used to modify ransomware protection policies.PUT /v5/{project_id}/ransomware/protection/policyNoneModify the ransomware protection policy. Set the OS type to",
"product_code":"hss",
"title":"Modifying Ransomware Protection Policies",
"uri":"UpdateProtectionPolicy.html",
"doc_type":"api",
"p_code":"17",
"code":"19"
},
{
"desc":"This API is used to disable ransomware prevention.POST /v5/{project_id}/ransomware/protection/closeNoneDisable ransomware protection for the server. The target server ID ",
"product_code":"hss",
"title":"Disabling Ransomware Prevention",
"uri":"StopProtection.html",
"doc_type":"api",
"p_code":"17",
"code":"20"
},
{
"desc":"This API is used to modify the backup policy associated with the vaultPUT /v5/{project_id}/backup/policyNoneModify the backup policy. The target backup policy ID is af4d0",
"product_code":"hss",
"title":"Modifying the Backup Policy Bound to HSS Protection Vault",
"uri":"UpdateBackupPolicyInfo.html",
"doc_type":"api",
"p_code":"17",
"code":"21"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Baseline Management",
"uri":"topic_300000002.html",
"doc_type":"api",
"p_code":"2",
"code":"22"
},
{
"desc":"This API is used to query the list of weak password detection results.GET /v5/{project_id}/baseline/weak-password-usersStatus code: 200Query the weak password of servers ",
"product_code":"hss",
"title":"Querying the Weak Password Detection Result List",
"uri":"ListWeakPasswordUsers.html",
"doc_type":"api",
"p_code":"22",
"code":"23"
},
{
"desc":"This API is used to query the password complexity policy detection report.GET /v5/{project_id}/baseline/password-complexityStatus code: 200Query the password complexity o",
"product_code":"hss",
"title":"Querying the Password Complexity Policy Detection Report",
"uri":"ListPasswordComplexity.html",
"doc_type":"api",
"p_code":"22",
"code":"24"
},
{
"desc":"This API is used to query the result list of a user's server security configuration check.GET /v5/{project_id}/baseline/risk-configsStatus code: 200This API is used to qu",
"product_code":"hss",
"title":"Querying the Result List of Server Security Configuration Check",
"uri":"ListRiskConfigs.html",
"doc_type":"api",
"p_code":"22",
"code":"25"
},
{
"desc":"This API is used to query the check result of a specified security configuration item.GET /v5/{project_id}/baseline/risk-config/{check_name}/detailStatus code: 200This AP",
"product_code":"hss",
"title":"Querying the Check Result of a Security Configuration Item",
"uri":"ShowRiskConfigDetail.html",
"doc_type":"api",
"p_code":"22",
"code":"26"
},
{
"desc":"This API is used to query the checklist of a specified security configuration item.GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rulesStatus code: 200This ",
"product_code":"hss",
"title":"Querying the Checklist of a Security Configuration Item",
"uri":"ListRiskConfigCheckRules.html",
"doc_type":"api",
"p_code":"22",
"code":"27"
},
{
"desc":"This API is used to query the list of affected servers of a specified security configuration item.GET /v5/{project_id}/baseline/risk-config/{check_name}/hostsStatus code:",
"product_code":"hss",
"title":"Querying the List of Affected Servers of a Security Configuration Item",
"uri":"ListRiskConfigHosts.html",
"doc_type":"api",
"p_code":"22",
"code":"28"
},
{
"desc":"This API is used to query the report of a check item in a security configuration check.GET /v5/{project_id}/baseline/check-rule/detailStatus code: 200This API is used to ",
"product_code":"hss",
"title":"Querying the Report of a Check Item in a Security Configuration Check",
"uri":"ShowCheckRuleDetail.html",
"doc_type":"api",
"p_code":"22",
"code":"29"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Quota Management",
"uri":"topic_300000003.html",
"doc_type":"api",
"p_code":"2",
"code":"30"
},
{
"desc":"This API is used to query quota details.GET /v5/{project_id}/billing/quotas-detailStatus code: 200This API is used to query quotas details in all enterprise projects.Stat",
"product_code":"hss",
"title":"Querying Quota Details",
"uri":"ListQuotasDetail.html",
"doc_type":"api",
"p_code":"30",
"code":"31"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Intrusion Detection",
"uri":"topic_300000004.html",
"doc_type":"api",
"p_code":"2",
"code":"32"
},
{
"desc":"This API is used to query the detected intrusion list.GET /v5/{project_id}/event/eventsStatus code: 200Query the first 50 unprocessed server events whose enterprise proje",
"product_code":"hss",
"title":"Querying the Detected Intrusion List",
"uri":"ListSecurityEvents.html",
"doc_type":"api",
"p_code":"32",
"code":"33"
},
{
"desc":"This API is used to query the alarm whitelist.GET /v5/{project_id}/event/white-list/alarmStatus code: 200Query the first 10 alarm whitelists whose enterprise project is x",
"product_code":"hss",
"title":"Querying the Alarm Whitelist",
"uri":"ListAlarmWhiteList.html",
"doc_type":"api",
"p_code":"32",
"code":"34"
},
{
"desc":"This API is used to handle alarm events.POST /v5/{project_id}/event/operateNoneNoneSee Error Codes.",
"product_code":"hss",
"title":"Handling Alarm Events",
"uri":"ChangeEvent.html",
"doc_type":"api",
"p_code":"32",
"code":"35"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Server Management",
"uri":"topic_300000005.html",
"doc_type":"api",
"p_code":"2",
"code":"36"
},
{
"desc":"This API is used to query ECSs.GET /v5/{project_id}/host-management/hostsStatus code: 200Query the 10 Linux servers in all enterprise projects whose agent status is onlin",
"product_code":"hss",
"title":"Querying ECSs",
"uri":"ListHostStatus.html",
"doc_type":"api",
"p_code":"36",
"code":"37"
},
{
"desc":"This API is used to change the protection status.POST /v5/{project_id}/host-management/protectionNoneSwitch the protection edition of the server whose ID is 71a15ecc-049f",
"product_code":"hss",
"title":"Changing the Protection Status",
"uri":"SwitchHostsProtectStatus.html",
"doc_type":"api",
"p_code":"36",
"code":"38"
},
{
"desc":"This API is used to query server groups.GET /v5/{project_id}/host-management/groupsStatus code: 200Query the server group whose name is test.Status code: 200Server group ",
"product_code":"hss",
"title":"Querying Server Groups",
"uri":"ListHostGroups.html",
"doc_type":"api",
"p_code":"36",
"code":"39"
},
{
"desc":"This API is used to create a server group.POST /v5/{project_id}/host-management/groupsNoneCreate a server group named test. The ID of the server in the server group is 15",
"product_code":"hss",
"title":"Creating a Server Group",
"uri":"AddHostsGroup.html",
"doc_type":"api",
"p_code":"36",
"code":"40"
},
{
"desc":"This API is used to edit a server group.PUT /v5/{project_id}/host-management/groupsNoneEdit the server group named test. The server group ID is eca40dbe-27f7-4229-8f9d-a5",
"product_code":"hss",
"title":"Editing a Server Group",
"uri":"ChangeHostsGroup.html",
"doc_type":"api",
"p_code":"36",
"code":"41"
},
{
"desc":"This API is used to delete a server group.DELETE /v5/{project_id}/host-management/groupsNoneDelete the server group whose ID is 34fcf861-402b-45c6-9b6a-13087791aae3.NoneS",
"product_code":"hss",
"title":"Deleting a Server Group",
"uri":"DeleteHostsGroup.html",
"doc_type":"api",
"p_code":"36",
"code":"42"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Policy Management",
"uri":"topic_300000006.html",
"doc_type":"api",
"p_code":"2",
"code":"43"
},
{
"desc":"This API is used to query the policy group list.GET /v5/{project_id}/policy/groupsStatus code: 200Query the policy group list of all enterprise projects.Status code: 200P",
"product_code":"hss",
"title":"Querying the Policy Group List",
"uri":"ListPolicyGroup.html",
"doc_type":"api",
"p_code":"43",
"code":"44"
},
{
"desc":"Applying a policy groupPOST /v5/{project_id}/policy/deployNoneDeploy a server protection policy. The target server ID is 15462c0e-32c6-4217-a869-bbd131a00ecf, and the tar",
"product_code":"hss",
"title":"Applying a Policy Group",
"uri":"AssociatePolicyGroup.html",
"doc_type":"api",
"p_code":"43",
"code":"45"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Vulnerability Management",
"uri":"topic_300000007.html",
"doc_type":"api",
"p_code":"2",
"code":"46"
},
{
"desc":"This API is used to query the list of detected vulnerabilities.GET /v5/{project_id}/vulnerability/vulnerabilitiesStatus code: 200Query the first 10 records in the vulnera",
"product_code":"hss",
"title":"Querying the Vulnerability List",
"uri":"ListVulnerabilities.html",
"doc_type":"api",
"p_code":"46",
"code":"47"
},
{
"desc":"This API is used to query the servers affected by a vulnerability.GET /v5/{project_id}/vulnerability/hostsStatus code: 200Query the first 10 records in the list of server",
"product_code":"hss",
"title":"Querying the Servers Affected by a Vulnerability",
"uri":"ListVulHosts.html",
"doc_type":"api",
"p_code":"46",
"code":"48"
},
{
"desc":"This API is used to change the status of a vulnerability.PUT /v5/{project_id}/vulnerability/statusNoneChange the vulnerability status of the server whose ID is 71a15ecc-0",
"product_code":"hss",
"title":"Changing the Status of a Vulnerability",
"uri":"ChangeVulStatus.html",
"doc_type":"api",
"p_code":"46",
"code":"49"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Web Tamper Protection",
"uri":"topic_300000008.html",
"doc_type":"api",
"p_code":"2",
"code":"50"
},
{
"desc":"This API is used to enable or disable WTP.POST /v5/{project_id}/webtamper/static/statusNoneEnable WTP, set the target server IDs to a and b, and pay for the yearly/monthl",
"product_code":"hss",
"title":"Enabling or Disabling WTP",
"uri":"SetWtpProtectionStatusInfo.html",
"doc_type":"api",
"p_code":"50",
"code":"51"
},
{
"desc":"This API is used to enable or disable dynamic WTP.POST /v5/{project_id}/webtamper/rasp/statusNoneEnable dynamic WTP for servers a and b.NoneSee Error Codes.",
"product_code":"hss",
"title":"Enabling or Disabling Dynamic WTP",
"uri":"SetRaspSwitch.html",
"doc_type":"api",
"p_code":"50",
"code":"52"
},
{
"desc":"This API is used to query the status of static WTP for a server.GET /v5/{project_id}/webtamper/static/protect-historyStatus code: 200Query the static WTP status of a serv",
"product_code":"hss",
"title":"Querying the Status of Static WTP for a Server",
"uri":"ListHostProtectHistoryInfo.html",
"doc_type":"api",
"p_code":"50",
"code":"53"
},
{
"desc":"This API is used to query the status of dynamic WTP for a server.GET /v5/{project_id}/webtamper/rasp/protect-historyStatus code: 200Query the dynamic WTP status of a serv",
"product_code":"hss",
"title":"Querying the Status of Dynamic WTP for a Server",
"uri":"ListHostRaspProtectHistoryInfo.html",
"doc_type":"api",
"p_code":"50",
"code":"54"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Tag Management",
"uri":"topic_300000009.html",
"doc_type":"api",
"p_code":"2",
"code":"55"
},
{
"desc":"This API is used to create tags in batches.POST /v5/{project_id}/{resource_type}/{resource_id}/tags/createNoneCreate a tag key TESTKEY20220831190155 (the tag value is 2) ",
"product_code":"hss",
"title":"Creating Tags in Batches",
"uri":"BatchCreateTags.html",
"doc_type":"api",
"p_code":"55",
"code":"56"
},
{
"desc":"This API is used to delete a tag from a resource.DELETE /v5/{project_id}/{resource_type}/{resource_id}/tags/{key}NoneDelete the tag whose key is abc, project_id is 94b526",
"product_code":"hss",
"title":"Deleting a Resource Tag",
"uri":"DeleteResourceInstanceTag.html",
"doc_type":"api",
"p_code":"55",
"code":"57"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Appendixes",
"uri":"hss_02_0015.html",
"doc_type":"api",
"p_code":"",
"code":"58"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Status Codes",
"uri":"hss_02_0016.html",
"doc_type":"api",
"p_code":"58",
"code":"59"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Error Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
"p_code":"58",
"code":"60"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"hss",
"title":"Change History",
"uri":"hss_02_0017.html",
"doc_type":"api",
"p_code":"",
"code":"61"
}
]