This API is used to create a server group.
+POST /v5/{project_id}/host-management/groups
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Content-Type + |
+No + |
+String + |
+Default value: application/json; charset=utf-8 +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
group_name + |
+Yes + |
+String + |
+Server group name +Minimum: 1 +Maximum: 128 + |
+
host_id_list + |
+Yes + |
+Array of strings + |
+Server ID list +Minimum: 1 +Maximum: 128 +Array Length: 1 - 10000 + |
+
None
+Create a server group named test. The ID of the server in the server group is 15dac7fe-d81b-43bc-a4a7-4710fe673972.
+POST https://{endpoint}/v5/{project_id}/host-management/groups
+
+{
+ "group_name" : "test",
+ "host_id_list" : [ "15dac7fe-d81b-43bc-a4a7-4710fe673972" ]
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+success + |
+
400 + |
+Invalid parameter. + |
+
401 + |
+Authentication failed. + |
+
403 + |
+Insufficient permission. + |
+
404 + |
+Resource not found. + |
+
500 + |
+System error. + |
+
See Error Codes.
+Applying a policy group
+POST /v5/{project_id}/policy/deploy
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Content-Type + |
+No + |
+String + |
+Default value: application/json; charset=utf-8 +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
target_policy_group_id + |
+Yes + |
+String + |
+ID of the policy group to be deployed +Minimum: 36 +Maximum: 64 + |
+
operate_all + |
+No + |
+Boolean + |
+Whether to deploy the policy for all servers. +
|
+
host_id_list + |
+No + |
+Array of strings + |
+IDs of servers where the policy group needs to be deployed +Minimum: 1 +Maximum: 128 +Array Length: 0 - 10000 + |
+
None
+Deploy a server protection policy. The target server ID is 15462c0e-32c6-4217-a869-bbd131a00ecf, and the target policy ID is f671f7-2677-4705-a320-de1a62bff306.
+POST https://{endpoint}/v5/{project_id}/policy/deploy
+
+{
+ "target_policy_group_id" : "1df671f7-2677-4705-a320-de1a62bff306",
+ "host_id_list" : [ "15462c0e-32c6-4217-a869-bbd131a00ecf" ],
+ "operate_all" : false
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Success + |
+
400 + |
+Invalid parameter. + |
+
401 + |
+Authentication failed. + |
+
403 + |
+Insufficient permission. + |
+
404 + |
+Resource not found. + |
+
500 + |
+System error. + |
+
See Error Codes.
+This API is used to create tags in batches.
+POST /v5/{project_id}/{resource_type}/{resource_id}/tags/create
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
resource_type + |
+Yes + |
+String + |
+Resource type defined by TMS. When HSS calls the API, the resource type is HSS. +Minimum: 1 +Maximum: 64 + |
+
resource_id + |
+Yes + |
+String + |
+Resource ID defined by TMS. When HSS calls the API, the resource ID is the quota ID. +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 512 + |
+
Content-Type + |
+No + |
+String + |
+Default value: application/json; charset=utf-8 +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
tags + |
+Yes + |
+Array of ResourceTagInfo objects + |
+Tag List +Array Length: 0 - 1024 + |
+
None
+Create a tag key TESTKEY20220831190155 (the tag value is 2) and a tag key test (the tag value is hss).
+POST https://{endpoint}/v5/05e1e8b7ba8010dd2f80c01070a8d4cd/hss/fbaa9aca-2b5f-11ee-8c64-fa163e139e02/tags/create
+
+{
+ "tags" : [ {
+ "key" : "TESTKEY20220831190155",
+ "value" : "2"
+ }, {
+ "key" : "test",
+ "value" : "hss"
+ } ]
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+success + |
+
400 + |
+Invalid parameter. + |
+
401 + |
+Authentication failed. + |
+
403 + |
+Insufficient permission. + |
+
404 + |
+Resources not found. + |
+
500 + |
+System error. + |
+
See Error Codes.
+This API is used to handle alarm events.
+POST /v5/{project_id}/event/operate
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 20 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
operate_type + |
+Yes + |
+String + |
+Handling method. Its value can be: +
|
+
handler + |
+No + |
+String + |
+Remarks. This API is available only for handled alarms. + |
+
operate_event_list + |
+Yes + |
+Array of OperateEventRequestInfo objects + |
+Operated event list +Array Length: 0 - 100 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
event_class_id + |
+Yes + |
+String + |
+Event category. Its value can be: +
|
+
event_id + |
+Yes + |
+String + |
+Event ID + |
+
event_type + |
+Yes + |
+Integer + |
+Intrusion type. Its value can be: +
|
+
occur_time + |
+Yes + |
+Integer + |
+Occurrence time, accurate to milliseconds. + |
+
operate_detail_list + |
+Yes + |
+Array of EventDetailRequestInfo objects + |
+Operation details list. If operate_type is set to add_to_alarm_whitelist or remove_from_alarm_whitelist, keyword and hash are mandatory. If operate_type is set to add_to_login_whitelist or remove_from_login_whitelist, the login_ip, private_ip, and login_user_name parameters are mandatory. If operate_type is set to isolate_and_kill or do_not_isolate_or_kill, the agent_id, file_hash, file_path, and process_pid parameters are mandatory. In other cases, the parameters are optional. +Array Length: 0 - 100 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
agent_id + |
+No + |
+String + |
+Agent ID + |
+
process_pid + |
+No + |
+Integer + |
+Process ID + |
+
file_hash + |
+No + |
+String + |
+File hash + |
+
file_path + |
+No + |
+String + |
+File path + |
+
file_attr + |
+No + |
+String + |
+File attribute + |
+
keyword + |
+No + |
+String + |
+Alarm event keyword, which is used only for the alarm whitelist. + |
+
hash + |
+No + |
+String + |
+Alarm event hash, which is used only for the alarm whitelist. + |
+
private_ip + |
+No + |
+String + |
+Server private IP address + |
+
login_ip + |
+No + |
+String + |
+Login source IP address + |
+
login_user_name + |
+No + |
+String + |
+Login username + |
+
None
+POST https://{endpoint}/v5/{project_id}/event/operate?enterprise_project_id=xxx
+
+{
+ "operate_type" : "mark_as_handled",
+ "handler" : "test",
+ "operate_event_list" : [ {
+ "event_class_id" : "rootkit_0001",
+ "event_id" : "2a71e1e2-60f4-4d56-b314-2038fdc39de6",
+ "occur_time" : 1672046760353,
+ "event_type" : 1010,
+ "operate_detail_list" : [ {
+ "agent_id" : "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8",
+ "file_hash" : "e8b50f0b91e3dce0885ccc5902846b139d28108a0a7976c9b8d43154c5dbc44d",
+ "file_path" : "/usr/test",
+ "process_pid" : 3123,
+ "file_attr" : 33261,
+ "keyword" : "file_path=/usr/test",
+ "hash" : "e8b50f0b91e3dce0885ccc5902846b139d28108a0a7976c9b8d43154c5dbc44d",
+ "login_ip" : "127.0.0.1",
+ "private_ip" : "127.0.0.2",
+ "login_user_name" : "root"
+ } ]
+ } ],
+ "x-request-examples-description-1" : "Manually handle the intrusion alarms whose alarm event type is Rootkit and alarm event ID is 2a71e1e2-60f4-4d56-b314-2038fdc39de6."
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+success + |
+
400 + |
+Invalid parameter. + |
+
401 + |
+Authentication failed. + |
+
403 + |
+Insufficient permission. + |
+
404 + |
+Resource not found. + |
+
500 + |
+System error. + |
+
See Error Codes.
+This API is used to edit a server group.
+PUT /v5/{project_id}/host-management/groups
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Content-Type + |
+No + |
+String + |
+Default value: application/json; charset=utf-8 +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
group_name + |
+No + |
+String + |
+Server group name + |
+
group_id + |
+Yes + |
+String + |
+Server group ID + |
+
host_id_list + |
+No + |
+Array of strings + |
+Server ID list + |
+
None
+Edit the server group named test. The server group ID is eca40dbe-27f7-4229-8f9d-a58213129fdc. The IDs of the servers in the server group are 15dac7fe-d81b-43bc-a4a7-4710fe673972 and 21303c5b-36ad-4510-a1b0-cb4ac4c2875c.
+PUT https://{endpoint}/v5/{project_id}/host-management/groups
+
+{
+ "group_id" : "eca40dbe-27f7-4229-8f9d-a58213129fdc",
+ "group_name" : "test",
+ "host_id_list" : [ "15dac7fe-d81b-43bc-a4a7-4710fe673972", "21303c5b-36ad-4510-a1b0-cb4ac4c2875c" ]
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+success + |
+
400 + |
+Invalid parameter. + |
+
401 + |
+Authentication failed. + |
+
403 + |
+Insufficient permission. + |
+
404 + |
+Resource not found. + |
+
500 + |
+System error. + |
+
See Error Codes.
+This API is used to change the status of a vulnerability.
+PUT /v5/{project_id}/vulnerability/status
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Content-Type + |
+No + |
+String + |
+Default value: application/json; charset=utf-8 +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
operate_type + |
+Yes + |
+String + |
+Operation type. Its value can be: +
|
+
data_list + |
+Yes + |
+Array of VulOperateInfo objects + |
+Vulnerability list +Array Length: 1 - 500 + |
+
None
+Change the vulnerability status of the server whose ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f. Change the status of EulerOS-SA-2021-1894 to ignored.
+{
+ "operate_type" : "ignore",
+ "data_list" : [ {
+ "vul_id" : "EulerOS-SA-2021-1894",
+ "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ]
+ } ]
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Successful + |
+
See Error Codes.
+This API is used to delete a server group.
+DELETE /v5/{project_id}/host-management/groups
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
group_id + |
+Yes + |
+String + |
+Server group ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
None
+Delete the server group whose ID is 34fcf861-402b-45c6-9b6a-13087791aae3.
+DELETE https://{endpoint}/v5/{project_id}/host-management/groups
+
+{
+ "group_id" : "34fcf861-402b-45c6-9b6a-13087791aae3"
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+success + |
+
400 + |
+Invalid parameter. + |
+
401 + |
+Authentication failed. + |
+
403 + |
+Insufficient permission. + |
+
404 + |
+Resource not found. + |
+
500 + |
+System error. + |
+
See Error Codes.
+This API is used to delete a tag from a resource.
+DELETE /v5/{project_id}/{resource_type}/{resource_id}/tags/{key}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
resource_type + |
+Yes + |
+String + |
+Resource type defined by TMS. When HSS calls the API, the resource type is HSS. +Minimum: 1 +Maximum: 64 + |
+
resource_id + |
+Yes + |
+String + |
+Resource ID defined by TMS. When HSS calls the API, the resource ID is the quota ID. +Minimum: 0 +Maximum: 128 + |
+
key + |
+Yes + |
+String + |
+Key to be deleted +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 512 + |
+
None
+Delete the tag whose key is abc, project_id is 94b5266c14ce489fa6549817f032dc61, resource_type is hss, and resource_id is 2acc46ee-34c2-40c2-8060-dc652e6c672a.
+DELETE https://{endpoint}/v5/94b5266c14ce489fa6549817f032dc61/hss/2acc46ee-34c2-40c2-8060-dc652e6c672a/tags/abc
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Success + |
+
400 + |
+Invalid parameter. + |
+
401 + |
+Authentication failed. + |
+
403 + |
+Insufficient permission. + |
+
404 + |
+Resources not found. + |
+
500 + |
+System error. + |
+
See Error Codes.
+Status Code + |
+Error Code + |
+Message + |
+Description + |
+Measure + |
+
|---|---|---|---|---|
400 + |
+HSS.0001 + |
+Invalid param error + |
+The parameter is invalid. + |
+Ensure parameter values are valid. + |
+
500 + |
+HSS.0041 + |
+Query host extend info error + |
+An error occurred during query. + |
+Ensure parameter values are valid. + |
+
This API is used to query the alarm whitelist.
+GET /v5/{project_id}/event/white-list/alarm
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 20 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
hash + |
+No + |
+String + |
+Hash value of the event whitelist description (SHA256 algorithm) +Minimum: 64 +Maximum: 64 + |
+
event_type + |
+No + |
+Integer + |
+Event type. Its value can be: +
Minimum: 1000 +Maximum: 30000 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 10 +Maximum: 1000 +Default: 10 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number + |
+
event_type_list + |
+Array of integers + |
+Types of events that can be filtered +Minimum: 0 +Maximum: 2147483647 +Array Length: 0 - 30000 + |
+
data_list + |
+Array of AlarmWhiteListResponseInfo objects + |
+Alarm whitelist details +Array Length: 0 - 100 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
enterprise_project_name + |
+String + |
+Enterprise project name + |
+
hash + |
+String + |
+Hash value of the event whitelist description (SHA256 algorithm) + |
+
description + |
+String + |
+Description + |
+
event_type + |
+Integer + |
+Intrusion type. Its value can be: +
|
+
update_time + |
+Long + |
+Time when the event whitelist is updated, in milliseconds. +Minimum: 0 +Maximum: 9223372036854775807 + |
+
Query the first 10 alarm whitelists whose enterprise project is xxx.
+GET https://{endpoint}/v5/{project_id}/event/white-list/alarm?limit=10&offset=0&enterprise_project_id=xxx
+Status code: 200
+Alarm whitelist
+{
+ "data_list" : [ {
+ "enterprise_project_name" : "All projects",
+ "event_type" : 1001,
+ "hash" : "9ab079e5398cba3a368ccffbd478f54c5ec3edadf6284ec049a73c36419f1178",
+ "description" : "/opt/cloud/3rdComponent/install/jre-8u201/bin/java",
+ "update_time" : 1665715677307
+ } ],
+ "event_type_list" : [ 1001 ],
+ "total_num" : 1
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Alarm whitelist + |
+
See Error Codes.
+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-history
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
host_id + |
+No + |
+String + |
+Server ID +Minimum: 0 +Maximum: 128 + |
+
host_ip + |
+No + |
+String + |
+Server IP address +Minimum: 0 +Maximum: 128 + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 0 +Maximum: 128 + |
+
app_name + |
+No + |
+String + |
+Software name +Minimum: 0 +Maximum: 128 + |
+
variation_type + |
+No + |
+String + |
+Change type. Its value can be: +
|
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 256 + |
+
sort_key + |
+No + |
+String + |
+Sort key. Currently, sorting by recent_scan_time is supported. When data is sorted by recent_scan_time, the value of sort_dir determines whether to sort data in ascending or descending order. +Minimum: 1 +Maximum: 128 + |
+
sort_dir + |
+No + |
+String + |
+Sorting mode. The default value is descending. When sort_key is set to recent_scan_time, the current value determines whether to sort data in ascending or descending order. When sort_key is set to other values, the default value is descending. +
|
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 100 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 10000 +Default: 0 + |
+
start_time + |
+No + |
+Long + |
+Start time of a change. Its value is a 13-digit timestamp. +Minimum: 0 +Maximum: 9007199254740992 + |
+
end_time + |
+No + |
+Long + |
+End time of a change. Its value is a 13-digit timestamp. +Minimum: 0 +Maximum: 9007199254740992 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Number of software changes +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of AppChangeResponseInfo objects + |
+Account change history +Array Length: 0 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
agent_id + |
+String + |
+Agent ID +Minimum: 0 +Maximum: 128 + |
+
variation_type + |
+String + |
+Type of change. +
Minimum: 0 +Maximum: 10 + |
+
host_id + |
+String + |
+host_id +Minimum: 1 +Maximum: 128 + |
+
app_name + |
+String + |
+Software name +Minimum: 1 +Maximum: 128 + |
+
host_name + |
+String + |
+Host name +Minimum: 1 +Maximum: 128 + |
+
host_ip + |
+String + |
+Server IP address +Minimum: 1 +Maximum: 256 + |
+
version + |
+String + |
+Version number +Minimum: 1 +Maximum: 128 + |
+
update_time + |
+Long + |
+Software update time, in milliseconds. +Minimum: 0 +Maximum: 4824430336000 + |
+
recent_scan_time + |
+Long + |
+Last scan time, in ms. +Minimum: 0 +Maximum: 4824430336000 + |
+
The first 10 software change records whose start time is 1700446175490 and end time is 1701050975490 are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/app/change-history?start_time=1700446175490&end_time=1701050975490
+Status code: 200
+App change history info list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "agent_id" : "d83c7be8a106485a558f97446617443b87604c8116e3cf0453c2a44exxxxxxxx",
+ "variation_type" : "add",
+ "host_id" : "f4aaca51-xxxx-xxxx-xxxx-891c9e84d885",
+ "app_name" : "hostguard",
+ "host_name" : "host_name",
+ "host_ip" : "host_ip",
+ "version" : "3.2.3",
+ "update_time" : 1668246126302,
+ "recent_scan_time" : 1668246126302
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+App change history info list + |
+
See Error Codes.
+This API is used to check software information in asset fingerprints.
+GET /v5/{project_id}/asset/app/statistics
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
app_name + |
+No + |
+String + |
+Software name +Minimum: 1 +Maximum: 256 + |
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 100 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 10000 +Default: 0 + |
+
category + |
+No + |
+String + |
+Type. The default value is host. The options are as follows: +
Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of process statistics +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of AppStatisticResponseInfo objects + |
+Process statistics list +Array Length: 0 - 10000 + |
+
The first 10 software lists whose type is host are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/app/statistics?category=host
+Status code: 200
+Number of servers having the software
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "app_name" : "kernel",
+ "num" : 13
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Number of servers having the software + |
+
See Error Codes.
+This API is used to check software information in the asset fingerprints of a server.
+GET /v5/{project_id}/asset/apps
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
host_id + |
+Yes + |
+String + |
+Server ID +Minimum: 0 +Maximum: 128 + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 0 +Maximum: 128 + |
+
app_name + |
+No + |
+String + |
+Software name +Minimum: 0 +Maximum: 128 + |
+
host_ip + |
+No + |
+String + |
+Server IP address +Minimum: 0 +Maximum: 128 + |
+
version + |
+No + |
+String + |
+Software version +Minimum: 0 +Maximum: 128 + |
+
install_dir + |
+No + |
+String + |
+Installation directory +Minimum: 0 +Maximum: 512 + |
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 100 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 10000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total software +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of AppResponseInfo objects + |
+Software list +Array Length: 0 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
agent_id + |
+String + |
+Agent ID +Minimum: 0 +Maximum: 128 + |
+
host_id + |
+String + |
+Server ID +Minimum: 1 +Maximum: 128 + |
+
host_name + |
+String + |
+Server name +Minimum: 1 +Maximum: 256 + |
+
host_ip + |
+String + |
+Server IP address +Minimum: 1 +Maximum: 256 + |
+
app_name + |
+String + |
+Software name +Minimum: 1 +Maximum: 128 + |
+
version + |
+String + |
+Version number +Minimum: 1 +Maximum: 128 + |
+
update_time + |
+Long + |
+Latest update time, in milliseconds. +Minimum: 0 +Maximum: 2147483647 + |
+
recent_scan_time + |
+Long + |
+Last scanned, in ms. +Minimum: 0 +Maximum: 2147483647 + |
+
The first 10 servers whose software name is ACL are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/apps?app_name=acl
+Status code: 200
+Applications installed on a host
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "agent_id" : "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8",
+ "host_id" : "55dac7fe-d81b-43bc-a4a7-4710fe673972",
+ "host_name" : "xxxx",
+ "host_ip" : "192.168.0.126",
+ "app_name" : "acl",
+ "version" : "2.2.51-14.eulerosv2r7",
+ "update_time" : 1668150671981,
+ "recent_scan_time" : 1668506044147
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Applications installed on a host + |
+
See Error Codes.
+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-history
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
host_id + |
+No + |
+String + |
+Server ID +Minimum: 0 +Maximum: 128 + |
+
host_ip + |
+No + |
+String + |
+Server IP address +Minimum: 0 +Maximum: 128 + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 0 +Maximum: 128 + |
+
auto_launch_name + |
+No + |
+String + |
+Auto-started item name +Minimum: 0 +Maximum: 128 + |
+
type + |
+No + |
+Integer + |
+Auto-started item type. +
|
+
variation_type + |
+No + |
+String + |
+Change type. Its value can be: +
|
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 256 + |
+
sort_key + |
+No + |
+String + |
+Key value for sorting. Currently, data can be sorted only by recent_scan_time. When data is sorted by recent_scan_time, the value of sort_dir determines whether to sort the data in ascending or descending order. +Minimum: 0 +Maximum: 128 + |
+
sort_dir + |
+No + |
+String + |
+Sorting mode. The default value is descending. When sort_key is set to recent_scan_time, the current value determines whether to sort data in ascending or descending order. When sort_key is set to other values, the default value is descending. +
|
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
start_time + |
+No + |
+Long + |
+Start time of a change. Its value is a 13-digit timestamp. +Minimum: 0 +Maximum: 9007199254740992 + |
+
end_time + |
+No + |
+Long + |
+End time of a change. Its value is a 13-digit timestamp. +Minimum: 0 +Maximum: 9007199254740992 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Number of changes of auto-started items +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of AutoLaunchChangeResponseInfo objects + |
+Account change history +Array Length: 0 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
agent_id + |
+String + |
+Agent ID +Minimum: 0 +Maximum: 128 + |
+
variation_type + |
+String + |
+Type of change. +
Minimum: 0 +Maximum: 10 + |
+
type + |
+Integer + |
+Auto-started item type +
Minimum: 0 +Maximum: 11 + |
+
host_id + |
+String + |
+host_id +Minimum: 1 +Maximum: 128 + |
+
host_name + |
+String + |
+ECS name +Minimum: 1 +Maximum: 256 + |
+
host_ip + |
+String + |
+Server IP address +Minimum: 1 +Maximum: 256 + |
+
path + |
+String + |
+Path of the auto-startup item +Minimum: 1 +Maximum: 256 + |
+
hash + |
+String + |
+Hash value of the file generated using the SHA256 algorithm +Minimum: 1 +Maximum: 128 + |
+
run_user + |
+String + |
+User who starts the execution +Minimum: 1 +Maximum: 64 + |
+
name + |
+String + |
+Auto-started item name +Minimum: 1 +Maximum: 256 + |
+
recent_scan_time + |
+Long + |
+Last update time. The value is a 13-bit timestamp. +Minimum: 0 +Maximum: 4824430336000 + |
+
The first 10 auto-startup item change records whose start time is 1693101881568 and end time is 1701050681569 are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/auto-launch/change-history?start_time=1693101881568&end_time=1701050681569
+Status code: 200
+App change history info list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "agent_id" : "d83c7be8a106485a558f97446617443b87604c8116e3cf0453c2a44exxxxxxxx",
+ "variation_type" : "add",
+ "type" : 0,
+ "host_id" : "host_id",
+ "host_name" : "host_name",
+ "host_ip" : "host_ip",
+ "path" : "/path",
+ "hash" : "xxxxxxxx227bffa0c04425ba6c8e0024046caa38dfbca6281b40109axxxxxxxx",
+ "run_user" : "SYSTEM",
+ "name" : "S12hostguard",
+ "recent_scan_time" : 1668246126302
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+App change history info list + |
+
See Error Codes.
+This API is used to check auto-started items in asset fingerprints.
+GET /v5/{project_id}/asset/auto-launch/statistics
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+No + |
+String + |
+Auto-started item name +Minimum: 1 +Maximum: 256 + |
+
type + |
+No + |
+String + |
+Auto-started item type +
|
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 100 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 10000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of auto-started items +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of AutoLaunchStatisticsResponseInfo objects + |
+List of auto-started item statistics +Array Length: 0 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
name + |
+String + |
+Auto-started item name +Minimum: 1 +Maximum: 256 + |
+
type + |
+String + |
+Auto-started item type +
Minimum: 1 +Maximum: 11 + |
+
num + |
+Integer + |
+Indicates the number of servers of auto-started items. +Minimum: 0 +Maximum: 10000 + |
+
The first 10 auto-startup items are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/auto-launch/statistics
+Status code: 200
+Number of servers having the process
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "name" : "S12hostguard",
+ "type" : "0",
+ "num" : 5
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Number of servers having the process + |
+
See Error Codes.
+This API is used to check auto-started items in the asset fingerprints of a server.
+GET /v5/{project_id}/asset/auto-launchs
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
host_id + |
+No + |
+String + |
+Server ID +Minimum: 1 +Maximum: 128 + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 1 +Maximum: 128 + |
+
name + |
+No + |
+String + |
+Auto-started item name +Minimum: 1 +Maximum: 256 + |
+
host_ip + |
+No + |
+String + |
+Server IP address +Minimum: 1 +Maximum: 128 + |
+
type + |
+No + |
+String + |
+Auto-started item type +
|
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 100 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 10000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of auto-startup items +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of AutoLauchResponseInfo objects + |
+Auto-started item list +Array Length: 0 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
agent_id + |
+String + |
+Agent ID +Minimum: 0 +Maximum: 128 + |
+
host_id + |
+String + |
+Server ID +Minimum: 1 +Maximum: 128 + |
+
host_name + |
+String + |
+Server name +Minimum: 1 +Maximum: 256 + |
+
host_ip + |
+String + |
+Server IP address +Minimum: 1 +Maximum: 256 + |
+
name + |
+String + |
+Auto-started item name +Minimum: 1 +Maximum: 256 + |
+
type + |
+Integer + |
+Auto-started item type +
Minimum: 0 +Maximum: 11 + |
+
path + |
+String + |
+Path of the auto-startup item +Minimum: 1 +Maximum: 256 + |
+
hash + |
+String + |
+Hash value of the file generated using the SHA256 algorithm +Minimum: 1 +Maximum: 128 + |
+
run_user + |
+String + |
+User who starts the execution +Minimum: 1 +Maximum: 128 + |
+
recent_scan_time + |
+Long + |
+Latest scan time, in ms. +Minimum: 0 +Maximum: 4824430336000 + |
+
The first 10 services whose auto-startup item name is S50multi-queue are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/auto-launchs?name=S50multi-queue
+Status code: 200
+auto launch list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "agent_id" : "9e742932bff2894e3d0869d03989b05cefb27a6cbc201d98c4465296xxxxxxxx",
+ "host_id" : "3d0581a5-03b9-4311-9149-c026b0726a7e",
+ "host_name" : "name",
+ "host_ip" : "3d0581a5-03b9-4311-9149-c026b0726a7e",
+ "name" : "S12hostguard",
+ "type" : 0,
+ "path" : "/etc/hostguard",
+ "hash" : "xxxxxxxx227bffa0c04425ba6c8e0024046caa38dfbca6281b40109axxxxxxxx",
+ "run_user" : "user",
+ "recent_scan_time" : 1668240858425
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+auto launch list + |
+
See Error Codes.
+This API is used to query server groups.
+GET /v5/{project_id}/host-management/groups
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
group_name + |
+No + |
+String + |
+Server group name +Minimum: 1 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number + |
+
data_list + |
+Array of HostGroupItem objects + |
+Server group list +Array Length: 0 - 100 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
group_id + |
+String + |
+Server group ID + |
+
group_name + |
+String + |
+Server group name + |
+
host_num + |
+Integer + |
+Number of associated servers + |
+
risk_host_num + |
+Integer + |
+Number of unsafe servers + |
+
unprotect_host_num + |
+Integer + |
+Number of unprotected servers + |
+
host_id_list + |
+Array of strings + |
+Server ID list + |
+
Query the server group whose name is test.
+GET https://{endpoint}/v5/{project_id}/host-management/groups?offset=0&limit=200&enterprise_project_id=all_granted_eps&&group_name=test
+Status code: 200
+Server group list
+{
+ "data_list" : [ {
+ "group_id" : "36e59701-e2e7-4d56-b229-0db3bcf4e6e8",
+ "group_name" : "test",
+ "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
+ "host_num" : 1,
+ "risk_host_num" : 1,
+ "unprotect_host_num" : 0
+ } ],
+ "total_num" : 1
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Server group list + |
+
See Error Codes.
+This API is used to query the status of static WTP for a server.
+GET /v5/{project_id}/webtamper/static/protect-history
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
host_id + |
+No + |
+String + |
+Host ID. If this parameter is left empty, all the servers are queried. +Minimum: 0 +Maximum: 128 + |
+
start_time + |
+Yes + |
+Long + |
+Start time (ms) +Minimum: 0 +Maximum: 4070880000000 + |
+
end_time + |
+Yes + |
+Long + |
+End time (ms) +Minimum: 0 +Maximum: 4070880000000 + |
+
limit + |
+Yes + |
+Integer + |
+Number of records displayed on each page. +Minimum: 0 +Maximum: 100 + |
+
offset + |
+Yes + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 100 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
host_name + |
+String + |
+Server name +Minimum: 0 +Maximum: 256 + |
+
protect_status + |
+String + |
+Protection status. Its value can be: +
|
+
total_num + |
+Long + |
+total number of static WTPs +Minimum: 0 +Maximum: 20000000 + |
+
data_list + |
+Array of HostProtectHistoryResponseInfo objects + |
+data list +Array Length: 0 - 20000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
occr_time + |
+Long + |
+Static WTP detection time (ms) +Minimum: 0 +Maximum: 4070880000000 + |
+
file_path + |
+String + |
+Tampered file path +Minimum: 0 +Maximum: 2000 + |
+
process_id + |
+String + |
+Process ID. This parameter is returned if the OS is Windows. +Minimum: 0 +Maximum: 8 + |
+
process_name + |
+String + |
+Process name. This parameter is returned if the OS is Windows. +Minimum: 0 +Maximum: 200 + |
+
process_cmd + |
+String + |
+Process command line. This parameter is returned if the OS is Windows. +Minimum: 0 +Maximum: 8191 + |
+
Query the static WTP status of a server where target ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1668563099000, and end time is 1668563199000.
+GET https://{endpoint}/v5/{project_id}/webtamper/static/protect-history
+
+{
+ "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515",
+ "start_time" : 1668563099000,
+ "end_time" : 1668563199000,
+ "limit" : 10,
+ "offset" : 0
+}
+Status code: 200
+successful response
+{
+ "host_name" : "ecs-ubuntu",
+ "protect_status" : "opened",
+ "total_num" : 1,
+ "data_list" : [ {
+ "occr_time" : 1668156691000,
+ "file_path" : "/root/test/tamper/test.xml",
+ "process_id" : "18672",
+ "process_name" : "program1",
+ "process_cmd" : "del test.xml"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+successful response + |
+
See Error Codes.
+This API is used to query the status of dynamic WTP for a server.
+GET /v5/{project_id}/webtamper/rasp/protect-history
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
host_id + |
+No + |
+String + |
+Host ID. If this parameter is left empty, all the servers are queried. +Minimum: 0 +Maximum: 128 + |
+
start_time + |
+Yes + |
+Long + |
+Start time (ms) +Minimum: 0 +Maximum: 4070880000000 + |
+
end_time + |
+Yes + |
+Long + |
+End time (ms) +Minimum: 0 +Maximum: 4070880000000 + |
+
limit + |
+Yes + |
+Integer + |
+Number of records displayed on each page. +Minimum: 0 +Maximum: 100 + |
+
offset + |
+Yes + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 100 + |
+
alarm_level + |
+No + |
+Integer + |
+Alarm severity. The options are as follows: +
Minimum: 0 +Maximum: 100 + |
+
severity + |
+No + |
+String + |
+Threat level. Its value can be: +
Minimum: 0 +Maximum: 32 + |
+
protect_status + |
+No + |
+String + |
+Protection status. +
Minimum: 0 +Maximum: 32 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Long + |
+total number of dynamic WTPs +Minimum: 0 +Maximum: 200000 + |
+
data_list + |
+Array of HostRaspProtectHistoryResponseInfo objects + |
+data list +Array Length: 0 - 200000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
alarm_time + |
+Long + |
+Alarm time of dynamic WTP (ms) +Minimum: 0 +Maximum: 4070880000000 + |
+
threat_type + |
+String + |
+Threat type +Minimum: 0 +Maximum: 64 + |
+
alarm_level + |
+Integer + |
+Alarm severity +Minimum: 0 +Maximum: 100 + |
+
source_ip + |
+String + |
+Source IP address of the attacking server +Minimum: 0 +Maximum: 128 + |
+
attacked_url + |
+String + |
+URL of the attack request +Minimum: 0 +Maximum: 2000 + |
+
Query the dynamic WTP status of a server where target ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1668563099000, and end time is 1668563199000.
+GET https://{endpoint}/v5/{project_id}/webtamper/rasp/protect-history
+
+{
+ "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515",
+ "start_time" : 1668563099000,
+ "end_time" : 1668563199000,
+ "limit" : 10,
+ "offset" : 0
+}
+Status code: 200
+successful response
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "alarm_level" : 2,
+ "alarm_time" : 1668394634000,
+ "attacked_url" : "/vulns/001-dir-1.jsp",
+ "source_ip" : "10.100.30.200",
+ "threat_type" : "Path Traversal"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+successful response + |
+
See Error Codes.
+This API is used to query ECSs.
+GET /v5/{project_id}/host-management/hosts
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
version + |
+No + |
+String + |
+HSS edition. Its values and their meaning are as follows: +
|
+
agent_status + |
+No + |
+String + |
+Agent status. Its value can be: +
|
+
detect_result + |
+No + |
+String + |
+Detection result. Its value can be: +
|
+
host_name + |
+No + |
+String + |
+Server name + |
+
host_id + |
+No + |
+String + |
+Server ID + |
+
host_status + |
+No + |
+String + |
+Host status. Its value can be: +
|
+
os_type + |
+No + |
+String + |
+OS type. Its value can be: +
|
+
private_ip + |
+No + |
+String + |
+Server private IP address + |
+
public_ip + |
+No + |
+String + |
+Server public IP address + |
+
ip_addr + |
+No + |
+String + |
+Public or private IP address + |
+
protect_status + |
+No + |
+String + |
+Protection status. Its value can be: +
|
+
group_id + |
+No + |
+String + |
+Server group ID + |
+
group_name + |
+No + |
+String + |
+Server group name +Minimum: 1 +Maximum: 64 + |
+
policy_group_id + |
+No + |
+String + |
+Policy group ID +Minimum: 0 +Maximum: 128 + |
+
policy_group_name + |
+No + |
+String + |
+Policy group name +Minimum: 0 +Maximum: 256 + |
+
charging_mode + |
+No + |
+String + |
+on_demand: pay-per-use + |
+
refresh + |
+No + |
+Boolean + |
+Whether to forcibly synchronize servers from ECSs + |
+
above_version + |
+No + |
+Boolean + |
+Whether to return all the versions later than the current version + |
+
outside_host + |
+No + |
+Boolean + |
+Whether a server is a non-cloud server + |
+
asset_value + |
+No + |
+String + |
+Asset importance. Its value can be: +
|
+
label + |
+No + |
+String + |
+Asset tag +Minimum: 1 +Maximum: 64 + |
+
server_group + |
+No + |
+String + |
+Asset server group +Minimum: 1 +Maximum: 64 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 0 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of records +Minimum: 0 +Maximum: 2097152 + |
+
data_list + |
+Array of Host objects + |
+Query on the cloud server status and list +Array Length: 0 - 10241 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
host_name + |
+String + |
+Server name +Minimum: 0 +Maximum: 128 + |
+
host_id + |
+String + |
+Server ID +Minimum: 0 +Maximum: 128 + |
+
agent_id + |
+String + |
+Agent ID +Minimum: 0 +Maximum: 128 + |
+
private_ip + |
+String + |
+Private IP address +Minimum: 0 +Maximum: 128 + |
+
public_ip + |
+String + |
+Elastic IP address +Minimum: 0 +Maximum: 128 + |
+
enterprise_project_id + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Minimum: 0 +Maximum: 256 + |
+
enterprise_project_name + |
+String + |
+Enterprise project name +Minimum: 0 +Maximum: 256 + |
+
host_status + |
+String + |
+Server status. Its value can be: +
|
+
agent_status + |
+String + |
+Agent status. Its value can be: +
|
+
install_result_code + |
+String + |
+Installation result. This API is available only for agents that are installed in batches. The options are as follows: +
|
+
version + |
+String + |
+HSS edition. Its values and their meaning are as follows: +
|
+
protect_status + |
+String + |
+Protection status. Its value can be: +
|
+
os_image + |
+String + |
+System disk image +Minimum: 0 +Maximum: 128 + |
+
os_type + |
+String + |
+OS type. Its value can be: +
|
+
os_bit + |
+String + |
+OS bit version +Minimum: 0 +Maximum: 128 + |
+
detect_result + |
+String + |
+Server scan result. Its value can be: +
|
+
charging_mode + |
+String + |
+on_demand: pay-per-use + |
+
resource_id + |
+String + |
+Cloud service resource instance ID (UUID) +Minimum: 0 +Maximum: 128 + |
+
outside_host + |
+Boolean + |
+Whether a server is a non-cloud server + |
+
group_id + |
+String + |
+Server group ID +Minimum: 1 +Maximum: 128 + |
+
group_name + |
+String + |
+Server group name +Minimum: 1 +Maximum: 128 + |
+
policy_group_id + |
+String + |
+Policy group ID +Minimum: 1 +Maximum: 128 + |
+
policy_group_name + |
+String + |
+Policy group name +Minimum: 1 +Maximum: 128 + |
+
asset + |
+Integer + |
+Asset risk +Minimum: 0 +Maximum: 2097152 + |
+
vulnerability + |
+Integer + |
+Total number of vulnerabilities, including Linux, Windows, Web-CMS, and application vulnerabilities. +Minimum: 0 +Maximum: 2097152 + |
+
baseline + |
+Integer + |
+Total number of baseline risks, including configuration risks and weak passwords. +Minimum: 0 +Maximum: 2097152 + |
+
intrusion + |
+Integer + |
+Total intrusion risks +Minimum: 0 +Maximum: 2097152 + |
+
asset_value + |
+String + |
+Asset importance. Its value can be: +
|
+
labels + |
+Array of strings + |
+Tag list +Minimum: 0 +Maximum: 64 +Array Length: 0 - 100 + |
+
agent_create_time + |
+Long + |
+Agent installation time, which is a timestamp. The default unit is milliseconds. +Minimum: 0 +Maximum: 4824695185000 + |
+
agent_update_time + |
+Long + |
+Time when the agent status is changed. This is a timestamp. The default unit is milliseconds. +Minimum: 0 +Maximum: 4824695185000 + |
+
agent_version + |
+String + |
+Agent version +Minimum: 1 +Maximum: 32 + |
+
upgrade_status + |
+String + |
+Upgrade status. Its value can be: +
|
+
upgrade_result_code + |
+String + |
+Upgrade failure cause. This parameter is displayed only if upgrade_status is upgrade_failed. Its value can be: +
|
+
upgradable + |
+Boolean + |
+Whether the agent of the server can be upgraded + |
+
Query the 10 Linux servers in all enterprise projects whose agent status is online.
+GET https://{endpoint}/v5/{project_id}/host-management/hosts?limit=10&offset=0&agent_status=online&os_type=Linux&enterprise_project_id=all_granted_eps
+Status code: 200
+cloud server list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "agent_id" : "2758d2a61598fd9144cfa6b201049e7c0af8c3f1280cd24e3ec95a2f0811a2a2",
+ "agent_status" : "online",
+ "asset" : 0,
+ "asset_value" : "common",
+ "baseline" : 0,
+ "charging_mode" : "on_demand",
+ "detect_result" : "risk",
+ "enterprise_project_id" : "all_granted_eps",
+ "enterprise_project_name" : "default",
+ "group_id" : "7c659ea3-006f-4687-9f1c-6d975d955f37",
+ "group_name" : "default",
+ "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515",
+ "host_name" : "ecs-r00431580-ubuntu",
+ "host_status" : "ACTIVE",
+ "intrusion" : 0,
+ "expire_time" : -1,
+ "os_bit" : "64",
+ "os_type" : "Linux",
+ "outside_host" : false,
+ "policy_group_id" : "2758d2a61598fd9144cfa6b201049e7c0af8c3f1280cd24e3ec95a2f0811a2a2",
+ "policy_group_name" : "wtp_ecs-r00431580-ubuntu(default)",
+ "private_ip" : "192.168.0.182",
+ "protect_status" : "opened",
+ "public_ip" : "100.85.123.9",
+ "resource_id" : "60f08ea4-c74e-4a45-be1c-3c057e373af2",
+ "version" : "hss.version.wtp",
+ "vulnerability" : 97,
+ "labels" : [ "" ],
+ "agent_create_time" : 0,
+ "agent_update_time" : 0
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+cloud server list + |
+
See Error Codes.
+This API is used to query the password complexity policy detection report.
+GET /v5/{project_id}/baseline/password-complexity
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 256 + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 0 +Maximum: 128 + |
+
host_ip + |
+No + |
+String + |
+Server IP address +Minimum: 0 +Maximum: 128 + |
+
host_id + |
+No + |
+String + |
+Host ID. If this parameter is not specified, all hosts of a user are queried. +Minimum: 0 +Maximum: 128 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 0 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Long + |
+Total number of password complexity policies +Minimum: 0 +Maximum: 2147483647 + |
+
data_list + |
+Array of PwdPolicyInfoResponseInfo objects + |
+List of password complexity policy detection +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
host_id + |
+String + |
+Host ID +Minimum: 0 +Maximum: 64 + |
+
host_name + |
+String + |
+Server name +Minimum: 0 +Maximum: 256 + |
+
host_ip + |
+String + |
+Server IP address +Minimum: 0 +Maximum: 256 + |
+
min_length + |
+Boolean + |
+Indicates whether the minimum password length meets the requirements. If the value is true, the minimum password length meets the requirements. If the value is false, the minimum password length does not meet the requirements. + |
+
uppercase_letter + |
+Boolean + |
+Indicates whether the uppercase letters meet the requirements. If the value is true, the uppercase letters meet the requirements. If the value is false, the uppercase letters do not meet the requirements. + |
+
lowercase_letter + |
+Boolean + |
+Indicates whether the lowercase letters meet the requirements. If the value is true, the lowercase letters meet the requirements. If the value is false, the lowercase letters do not meet the requirements. + |
+
number + |
+Boolean + |
+Indicates whether the number meets the requirements. If the value is true, the number meets the requirements. If the value is false, the number does not meet the requirements. + |
+
special_character + |
+Boolean + |
+Indicates whether the special character meets the requirements. If the value is true, the special character meets the requirements. If the value is false, the special character does not meet the requirements. + |
+
suggestion + |
+String + |
+Modification suggestion +Minimum: 0 +Maximum: 65534 + |
+
Query the password complexity of the server whose enterprise project ID is xxx. Data on the first page (the first 10 records) is returned by default.
+GET https://{endpoint}/v5/{project_id}/baseline/password-complexity?enterprise_project_id=xxx
+Status code: 200
+password complexity policy check report
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "host_id" : "76fa440a-5a08-43fa-ac11-d12183ab3a14",
+ "host_ip" : "192.168.0.59",
+ "host_name" : "ecs-6b96",
+ "lowercase_letter" : false,
+ "min_length" : true,
+ "number" : false,
+ "special_character" : false,
+ "suggestion" : "The password should contain at least 3 of the following character types: uppercase letters, lowercase letters, digits, and special characters. ",
+ "uppercase_letter" : false
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+password complexity policy check report + |
+
See Error Codes.
+This API is used to query the policy group list.
+GET /v5/{project_id}/policy/groups
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
group_name + |
+No + |
+String + |
+Policy group name +Minimum: 1 +Maximum: 256 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 100000 +Default: 0 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number + |
+
data_list + |
+Array of PolicyGroupResponseInfo objects + |
+Policy group list +Array Length: 0 - 100 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
group_name + |
+String + |
+Policy group name + |
+
group_id + |
+String + |
+Policy group ID + |
+
description + |
+String + |
+Description of the policy group +Minimum: 1 +Maximum: 64 + |
+
deletable + |
+Boolean + |
+Whether a policy group can be deleted +
|
+
host_num + |
+Integer + |
+Number of associated servers + |
+
default_group + |
+Boolean + |
+Whether a policy group is the default policy group +
|
+
support_os + |
+String + |
+Supported OS. The options are as follows: +
|
+
support_version + |
+String + |
+Supported versions. The options are as follows: +
|
+
Query the policy group list of all enterprise projects.
+GET https://{endpoint}/v5/{project_id}/policy/groups?offset=0&limit=100&enterprise_project_id=all_granted_eps
+Status code: 200
+Policy group list
+{
+ "data_list" : [ {
+ "default_group" : true,
+ "deletable" : false,
+ "description" : "container policy group for linux",
+ "group_id" : "c831f177-226d-4b91-be0f-bcf98d04ef5d",
+ "group_name" : "tenant_linux_container_default_policy_group ",
+ "host_num" : 0,
+ "support_version" : "hss.version.container.enterprise",
+ "support_os" : "Linux"
+ }, {
+ "default_group" : true,
+ "deletable" : false,
+ "description" : "enterprise policy group for windows",
+ "group_id" : "1ff54b90-1b3e-42a9-a1da-9883a83385ce",
+ "group_name" : "tenant_windows_enterprise_default_policy_group ",
+ "host_num" : 0,
+ "support_version" : "hss.version.enterprise",
+ "support_os" : "Windows"
+ }, {
+ "default_group" : true,
+ "deletable" : false,
+ "description" : "enterprise policy group for linux",
+ "group_id" : "1069bcc0-c806-4ccd-a35d-f1f7456805e9",
+ "group_name" : "tenant_linux_enterprise_default_policy_group ",
+ "host_num" : 1,
+ "support_version" : "hss.version.enterprise",
+ "support_os" : "Linux"
+ }, {
+ "default_group" : true,
+ "deletable" : false,
+ "description" : "premium policy group for windows",
+ "group_id" : "11216d24-9e91-4a05-9212-c4c1d646ee79",
+ "group_name" : "tenant_windows_premium_default_policy_group ",
+ "host_num" : 0,
+ "support_version" : "hss.version.premium",
+ "support_os" : "Linux"
+ }, {
+ "default_group" : true,
+ "deletable" : false,
+ "description" : "premium policy group for linux",
+ "group_id" : "e6e1228a-7bb4-424f-a42b-755162234da7",
+ "group_name" : "tenant_linux_premium_default_policy_group ",
+ "host_num" : 0,
+ "support_version" : "hss.version.premium",
+ "support_os" : "Windows"
+ } ],
+ "total_num" : 5
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Policy group list + |
+
See Error Codes.
+This API is used to check open port information in asset fingerprints.
+GET /v5/{project_id}/asset/port/statistics
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
port + |
+No + |
+Integer + |
+Port number +Minimum: 1 +Maximum: 65535 + |
+
type + |
+No + |
+String + |
+Port type: TCP or UDP. +Minimum: 1 +Maximum: 256 + |
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 128 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
category + |
+No + |
+String + |
+Type. The default value is host. The options are as follows: +
|
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Number of open ports +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of PortStatisticResponseInfo objects + |
+Open port statistics list +Array Length: 0 - 10000 + |
+
The first 10 open ports whose port number is 123 and type is host are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/port/statistics?port=123&category=host
+Status code: 200
+Returns the port information, including the port number, type, and quantity.
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "num" : 4,
+ "port" : 123,
+ "type" : "UDP"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Returns the port information, including the port number, type, and quantity. + |
+
See Error Codes.
+This API is used to check open port information in the asset fingerprints of a server.
+GET /v5/{project_id}/asset/ports
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
host_id + |
+Yes + |
+String + |
+Server ID +Minimum: 0 +Maximum: 128 + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 0 +Maximum: 128 + |
+
host_ip + |
+No + |
+String + |
+Server IP address +Minimum: 0 +Maximum: 128 + |
+
port + |
+No + |
+Integer + |
+Port number +Minimum: 1 +Maximum: 65535 + |
+
type + |
+No + |
+String + |
+Port type: TCP or UDP. + |
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 256 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 100 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 10000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Number of open ports +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of PortResponseInfo objects + |
+Port information list +Array Length: 0 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
host_id + |
+String + |
+Server ID +Minimum: 1 +Maximum: 128 + |
+
laddr + |
+String + |
+Listening IP address +Minimum: 1 +Maximum: 128 + |
+
status + |
+String + |
+port status, normal, danger or unknow +
|
+
port + |
+Integer + |
+Port number +Minimum: 0 +Maximum: 65535 + |
+
type + |
+String + |
+Port type: TCP or UDP. + |
+
pid + |
+Integer + |
+Process ID +Minimum: 1 +Maximum: 65535 + |
+
path + |
+String + |
+Path of the process execution file. +Minimum: 1 +Maximum: 256 + |
+
agent_id + |
+String + |
+Agent ID +Minimum: 1 +Maximum: 64 + |
+
container_id + |
+String + |
+Container ID +Minimum: 0 +Maximum: 128 + |
+
The first 10 open ports whose host_id is dd91cd32-a238-4c0e-bc01-3b11653714ac are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/ports?hlimit=10&offset=0&host_id=dd91cd32-a238-4c0e-bc01-3b11653714ac
+Status code: 200
+Port information list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "host_id" : "3702fbd6-xxxx-xxxx-xxxx-6715770bxxxx",
+ "agent_id" : "eb5d03f02fffd85aaf5d0ba5c992d97713244f420e0b076dcf6ae0574c78aa4b",
+ "container_id" : "",
+ "laddr" : "0.0.0.0",
+ "path" : "/usr/sbin/",
+ "pid" : 1554,
+ "port" : 22,
+ "status" : "unknow",
+ "type" : "TCP"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Port information list + |
+
See Error Codes.
+This API is used to check process information in asset fingerprints.
+GET /v5/{project_id}/asset/process/statistics
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
path + |
+No + |
+String + |
+Executable process path +Minimum: 1 +Maximum: 256 + |
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 100 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 10000 +Default: 0 + |
+
category + |
+No + |
+String + |
+Type. The default value is host. The options are as follows: +
|
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of process statistics +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of ProcessStatisticResponseInfo objects + |
+Process statistics list +Array Length: 0 - 10000 + |
+
The first 10 processes whose type is host are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/process/statistics?category=host
+Status code: 200
+Number of servers having the process
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "num" : 13,
+ "path" : "/usr/lib/systemd/systemd-journald"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Number of servers having the process + |
+
See Error Codes.
+This API is used to query the protection policy list of ransomware.
+GET /v5/{project_id}/ransomware/protection/policy
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
policy_name + |
+No + |
+String + |
+Policy name +Minimum: 0 +Maximum: 128 + |
+
operating_system + |
+No + |
+String + |
+OSs supported by the policy. The options are as follows: +
|
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of policies +Minimum: 0 +Maximum: 2097152 + |
+
data_list + |
+Array of ProtectionPolicyInfo objects + |
+Query the list of policies. +Array Length: 0 - 10241 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
policy_id + |
+String + |
+Policy ID +Minimum: 0 +Maximum: 128 + |
+
policy_name + |
+String + |
+Policy name +Minimum: 0 +Maximum: 128 + |
+
protection_mode + |
+String + |
+Action. Its value can be: +
|
+
bait_protection_status + |
+String + |
+Whether to enable honeypot protection. By default, the protection is enabled. Its value can be: +
|
+
protection_directory + |
+String + |
+Protected directory +Minimum: 1 +Maximum: 128 + |
+
protection_type + |
+String + |
+Protected file type, for example, .docx, .txt, and .avi. +Minimum: 0 +Maximum: 128 + |
+
exclude_directory + |
+String + |
+(Optional) excluded directory +Minimum: 1 +Maximum: 128 + |
+
runtime_detection_status + |
+String + |
+Whether to perform runtime checks. The options are as follows. Currently, it can only be disabled. This field is reserved. +
|
+
runtime_detection_directory + |
+String + |
+Directory to be checked during running. This field is reserved. +Minimum: 1 +Maximum: 128 + |
+
count_associated_server + |
+Integer + |
+Number of associated servers +Minimum: 0 +Maximum: 2097152 + |
+
operating_system + |
+String + |
+OS type. Its value can be: +
|
+
Query the protection policy list of ransomware. If limit is not specified, 10 records are returned by default.
+GET https://{endpoint}/v5/{project_id}/ransomware/protection/policy
+Status code: 200
+Linux protection policy list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "bait_protection_status" : "opened",
+ "exclude_directory" : "/opt",
+ "count_associated_server" : 0,
+ "operating_system" : "Linux",
+ "protection_mode" : "alarm_only",
+ "policy_id" : "4117d16-074b-41ae-b7d7-9cc25ee258",
+ "policy_name" : "test",
+ "protection_directory" : "/dd",
+ "protection_type" : "docx",
+ "runtime_detection_status" : "closed"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Linux protection policy list + |
+
See Error Codes.
+This API is used to query quota details.
+GET /v5/{project_id}/billing/quotas-detail
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
version + |
+No + |
+String + |
+HSS edition. Its values and their meaning are as follows: +
|
+
category + |
+No + |
+String + |
+Type. Its value can be: +
|
+
quota_status + |
+No + |
+String + |
+Quota status. It can be: +
|
+
used_status + |
+No + |
+String + |
+Usage status. It can be: +
|
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 0 +Maximum: 128 + |
+
resource_id + |
+No + |
+String + |
+Specifies the resource ID of the HSS quota. +Minimum: 0 +Maximum: 128 + |
+
charging_mode + |
+No + |
+String + |
+on_demand: pay-per-use + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
on_demand_num + |
+Integer + |
+Pay-per-Use quotas +Minimum: 0 +Maximum: 10000000 + |
+
used_num + |
+Integer + |
+Used quotas +Minimum: 0 +Maximum: 10000000 + |
+
idle_num + |
+Integer + |
+Idle quotas +Minimum: 0 +Maximum: 10000000 + |
+
normal_num + |
+Integer + |
+Normal quotas +Minimum: 0 +Maximum: 10000000 + |
+
expired_num + |
+Integer + |
+Expired quotas +Minimum: 0 +Maximum: 10000000 + |
+
freeze_num + |
+Integer + |
+Frozen quotas +Minimum: 0 +Maximum: 10000000 + |
+
quota_statistics_list + |
+Array of QuotaStatisticsResponseInfo objects + |
+Quota statistics list +Array Length: 0 - 200 + |
+
total_num + |
+Integer + |
+Total quotas +Minimum: 0 +Maximum: 10000000 + |
+
data_list + |
+Array of QuotaResourcesResponseInfo objects + |
+Quota list +Array Length: 0 - 200 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
version + |
+String + |
+Resource specification code. Its value can be: +
|
+
total_num + |
+Integer + |
+Total quotas +Minimum: 0 +Maximum: 10000000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resource_id + |
+String + |
+Resource ID of an HSS quota +Minimum: 0 +Maximum: 256 + |
+
version + |
+String + |
+Resource specification code. Its value can be: +
|
+
quota_status + |
+String + |
+Quota status. It can be: +
|
+
used_status + |
+String + |
+Usage status. Its value can be: +
|
+
host_id + |
+String + |
+Host ID +Minimum: 1 +Maximum: 64 + |
+
host_name + |
+String + |
+Server name +Minimum: 1 +Maximum: 128 + |
+
charging_mode + |
+String + |
+on_demand: pay-per-use + |
+
tags + |
+Array of TagInfo objects + |
+Tag +Array Length: 0 - 2097152 + |
+
expire_time + |
+Long + |
+Expiration time. The value -1 indicates that the resource will not expire. +Minimum: 0 +Maximum: 2147483647 + |
+
shared_quota + |
+String + |
+Whether quotas are shared. Its value can be: +
|
+
enterprise_project_id + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Minimum: 0 +Maximum: 256 + |
+
enterprise_project_name + |
+String + |
+Enterprise project name +Minimum: 0 +Maximum: 256 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Key. It can contain up to 128 Unicode characters. The key cannot be left blank. +Minimum: 1 +Maximum: 128 + |
+
value + |
+String + |
+Value. Each tag value can contain a maximum of 255 Unicode characters. +Minimum: 1 +Maximum: 255 + |
+
This API is used to query quotas details in all enterprise projects.
+GET https://{endpoint}/v5/{project_id}/billing/quotas-detail?offset=0&limit=100&version=hss.version.enterprise&enterprise_project_id=all_granted_eps
+Status code: 200
+quota details
+{
+ "data_list" : [ {
+ "charging_mode" : "on_demand",
+ "expire_time" : -1,
+ "host_id" : "71a15ecc-049f-4cca-bd28-5e90aca1817f",
+ "host_name" : "zhangxiaodong2",
+ "quota_status" : "normal",
+ "resource_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
+ "shared_quota" : "shared",
+ "tags" : [ {
+ "key" : "Service",
+ "value" : "HSS"
+ } ],
+ "used_status" : "used",
+ "version" : "hss.version.enterprise"
+ } ],
+ "expired_num" : 0,
+ "freeze_num" : 0,
+ "idle_num" : 20,
+ "normal_num" : 60,
+ "on_demand_num" : 0,
+ "quota_statistics_list" : [ {
+ "total_num" : 8,
+ "version" : "hss.version.enterprise"
+ } ],
+ "total_num" : 60,
+ "used_num" : 40
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+quota details + |
+
See Error Codes.
+This API is used to query the checklist of a specified security configuration item.
+GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rules
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 20 +Maximum: 64 + |
+
check_name + |
+Yes + |
+String + |
+Name of the configuration check (baseline), for example, SSH, CentOS 7, and Windows. +Minimum: 0 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
standard + |
+Yes + |
+String + |
+hw_standard: Cloud security practice standard + |
+
result_type + |
+No + |
+String + |
+Result type. Its value can be: +
Default: unhandled + |
+
check_rule_name + |
+No + |
+String + |
+Check item name. Fuzzy match is supported. +Minimum: 0 +Maximum: 2048 + |
+
severity + |
+No + |
+String + |
+Risk level. Its value can be: +
|
+
host_id + |
+No + |
+String + |
+Server ID. If this parameter is not specified, all the servers of the user are queried. +Minimum: 0 +Maximum: 64 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 0 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 2097152 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Long + |
+Total risks +Minimum: 0 +Maximum: 9223372036854775807 + |
+
data_list + |
+Array of CheckRuleRiskInfoResponseInfo objects + |
+Data list +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
severity + |
+String + |
+Risk level. Its value can be: +
Minimum: 0 +Maximum: 255 + |
+
check_name + |
+String + |
+Name of the configuration check (baseline), for example, SSH, CentOS 7, and Windows. +Minimum: 0 +Maximum: 256 + |
+
check_type + |
+String + |
+Baseline type. The values for check_type and check_name are the same for Linux servers. For example, they can both be set to SSH or CentOS 7. For Windows servers, the values for check_type and check_name are different. For example, check_type can be set to Windows Server 2019 R2 or Windows Server 2016 R2. +Minimum: 0 +Maximum: 256 + |
+
standard + |
+String + |
+hw_standard: Cloud security practice standard + |
+
check_rule_name + |
+String + |
+Check item name +Minimum: 0 +Maximum: 2048 + |
+
check_rule_id + |
+String + |
+Check item ID +Minimum: 0 +Maximum: 64 + |
+
host_num + |
+Integer + |
+The number of servers on which the current baseline detection is performed. +Minimum: 0 +Maximum: 2147483647 + |
+
scan_result + |
+String + |
+Detection result. Its value can be: +
|
+
status + |
+String + |
+Status. Its value can be: +
|
+
enable_fix + |
+Integer + |
+Indicates whether one-click repair is supported. 1: yes; 0: no. + |
+
rule_params + |
+Array of CheckRuleFixParamInfo objects + |
+Range of parameters applicable to the check items that can be fixed by parameter transfer. This API is returned only for check items that support parameter transfer fix. +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
rule_param_id + |
+Integer + |
+Check item parameter ID +Minimum: 0 +Maximum: 10 + |
+
rule_desc + |
+String + |
+Check item parameter description +Minimum: 0 +Maximum: 256 + |
+
default_value + |
+Integer + |
+Default values of check item parameters +Minimum: 0 +Maximum: 2147483647 + |
+
range_min + |
+Integer + |
+Minimum value of check item parameters +Minimum: 0 +Maximum: 2147483647 + |
+
range_max + |
+Integer + |
+Minimum value of check item parameters +Minimum: 0 +Maximum: 2147483647 + |
+
This API is used to query the check items whose baseline name is SSH, check standard is cloud security practice standard, and enterprise project ID is xxx.
+GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/check-rules?standard=hw_standard&enterprise_project_id=xxx
+
+{
+ "standard" : "hw_standard"
+}
+Status code: 200
+checklist of the specified security configuration item
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "check_rule_id" : "1.1",
+ "check_rule_name" : "Rule:Ensure that permissions on /etc/ssh/sshd_config are configured.",
+ "check_type" : "SSH",
+ "host_num" : 2,
+ "scan_result" : "failed",
+ "severity" : "High",
+ "status" : "unhandled",
+ "enable_fix" : 1,
+ "enable_click" : true,
+ "rule_params" : [ {
+ "rule_param_id" : 1,
+ "rule_desc" : "Set the timeout duration.",
+ "default_value" : 5,
+ "range_min" : 1,
+ "range_max" : 10
+ }, {
+ "rule_param_id" : 2,
+ "rule_desc" : "Set the number of restarts.",
+ "default_value" : 10,
+ "range_min" : 1,
+ "range_max" : 20
+ } ]
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+checklist of the specified security configuration item + |
+
See Error Codes.
+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}/hosts
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 20 +Maximum: 64 + |
+
check_name + |
+Yes + |
+String + |
+Name of the configuration check (baseline), for example, SSH, CentOS 7, and Windows. +Minimum: 0 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
standard + |
+Yes + |
+String + |
+hw_standard: Cloud security practice standard + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 0 +Maximum: 256 + |
+
host_ip + |
+No + |
+String + |
+Server IP address +Minimum: 0 +Maximum: 256 + |
+
limit + |
+No + |
+Integer + |
+Number of items per page +Minimum: 0 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 2097152 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Long + |
+Total amount of data affected by configuration check +Minimum: 0 +Maximum: 2147483647 + |
+
data_list + |
+Array of SecurityCheckHostInfoResponseInfo objects + |
+Data list +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
host_id + |
+String + |
+Host ID +Minimum: 0 +Maximum: 64 + |
+
host_name + |
+String + |
+Server name +Minimum: 0 +Maximum: 256 + |
+
host_public_ip + |
+String + |
+Server public IP address +Minimum: 0 +Maximum: 128 + |
+
host_private_ip + |
+String + |
+Server private IP address +Minimum: 0 +Maximum: 256 + |
+
scan_time + |
+Long + |
+Scan time (ms) +Minimum: 0 +Maximum: 9223372036854775807 + |
+
failed_num + |
+Integer + |
+Number of risk items +Minimum: 0 +Maximum: 2147483647 + |
+
passed_num + |
+Integer + |
+Number of passed items +Minimum: 0 +Maximum: 2147483647 + |
+
This API is used to query the list of affected servers whose baseline name is SSH, check standard is cloud security practice standard, and enterprise project ID is xxx.
+GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/hosts?standard=hw_standard&enterprise_project_id=xxx
+Status code: 200
+servers affected by the security configuration item
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "failed_num" : 6,
+ "host_id" : "71a15ecc-049f-4cca-bd28-5e90aca1817f",
+ "host_name" : "zhangxiaodong2",
+ "host_private_ip" : "192.168.0.129",
+ "host_public_ip" : "*.*.*.10",
+ "passed_num" : 10,
+ "scan_time" : 1661716860935
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+servers affected by the security configuration item + |
+
See Error Codes.
+This API is used to query the result list of a user's server security configuration check.
+GET /v5/{project_id}/baseline/risk-configs
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 256 + |
+
check_name + |
+No + |
+String + |
+Baseline name, for example, SSH, CentOS 7, and Windows. +Minimum: 0 +Maximum: 256 + |
+
severity + |
+No + |
+String + |
+Risk level. Its value can be: +
|
+
standard + |
+No + |
+String + |
+hw_standard: Cloud security practice standard + |
+
host_id + |
+No + |
+String + |
+Host ID +Minimum: 0 +Maximum: 128 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 0 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Long + |
+Total number of records +Minimum: 0 +Maximum: 2147483647 + |
+
data_list + |
+Array of SecurityCheckInfoResponseInfo objects + |
+Server configuration check result list +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
severity + |
+String + |
+Risk level. Its value can be: +
|
+
check_name + |
+String + |
+Baseline name, for example, SSH, CentOS 7, and Windows. +Minimum: 0 +Maximum: 256 + |
+
check_type + |
+String + |
+Baseline type. The values for check_type and check_name are the same for Linux servers. For example, they can both be set to SSH or CentOS 7. For Windows servers, the values for check_type and check_name are different. For example, check_type can be set to Windows Server 2019 R2 or Windows Server 2016 R2. +Minimum: 0 +Maximum: 256 + |
+
standard + |
+String + |
+hw_standard: Cloud security practice standard + |
+
check_rule_num + |
+Integer + |
+Indicates the total number of check items of the current configuration check (baseline) type. For example, if the standard type of the SSH baseline is hw_standard, server security provides 17 check items, but only five check items of the SSH baseline are detected on all servers. Therefore, the value of check_rule_num is 5. All check items are checked on a server. The value of check_rule_num is 17. +Minimum: 0 +Maximum: 2097152 + |
+
failed_rule_num + |
+Integer + |
+Number of failed check items. If a server fails to pass a check item in check_rule_num, the item is counted in failed_rule_num. +Minimum: 0 +Maximum: 2097152 + |
+
host_num + |
+Integer + |
+The number of servers on which the current baseline detection is performed. +Minimum: 0 +Maximum: 2097152 + |
+
scan_time + |
+Long + |
+Latest detection time (ms) +Minimum: 0 +Maximum: 2097152 + |
+
check_type_desc + |
+String + |
+Description of the baseline type, including the standards for the check items and the issues that can be audited. +Minimum: 0 +Maximum: 65534 + |
+
This API is used to query the server baseline configuration check list whose enterprise project ID is xxx. Data on the first page (the first 10 records) is returned by default.
+GET https://{endpoint}/v5/{project_id}/baseline/risk-configs?enterprise_project_id=xxx
+Status code: 200
+server security configuration check result
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "check_name" : "Docker",
+ "check_rule_num" : 25,
+ "check_type" : "Docker",
+ "check_type_desc" : "Configuring security audit of Docker's host configurations and container-running-related contents based on Docker Container Security Specifications V1_0.",
+ "failed_rule_num" : 20,
+ "host_num" : 0,
+ "scan_time" : 1661716860935,
+ "severity" : "High",
+ "standard" : "hw_standard"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+server security configuration check result + |
+
See Error Codes.
+This API is used to query the detected intrusion list.
+GET /v5/{project_id}/event/events
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 20 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
category + |
+Yes + |
+String + |
+Event category. Its value can be: +
|
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
last_days + |
+No + |
+Integer + |
+Number of days to be queried. This parameter is mutually exclusive with begin_time and end_time. +Minimum: 1 +Maximum: 30 + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 1 +Maximum: 64 + |
+
host_id + |
+No + |
+String + |
+Host ID +Minimum: 0 +Maximum: 64 + |
+
private_ip + |
+No + |
+String + |
+Server IP address +Minimum: 1 +Maximum: 256 + |
+
container_name + |
+No + |
+String + |
+Container instance name + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page +Minimum: 10 +Maximum: 1000 +Default: 10 + |
+
event_types + |
+No + |
+Array + |
+Intrusion type. Its value can be: +
Minimum: 1000 +Maximum: 30000 +Array Length: 1 - 500 + |
+
handle_status + |
+No + |
+String + |
+Status. Its value can be: +
|
+
severity + |
+No + |
+String + |
+Threat level. Its value can be: +
|
+
begin_time + |
+No + |
+String + |
+Customized start time of a segment. The timestamp is accurate to seconds. The begin_time should be no more than two days earlier than the end_time. This parameter is mutually exclusive with the queried duration. +Minimum: 13 +Maximum: 13 + |
+
end_time + |
+No + |
+String + |
+Customized end time of a segment. The timestamp is accurate to seconds. The begin_time should be no more than two days earlier than the end_time. This parameter is mutually exclusive with the queried duration. +Minimum: 13 +Maximum: 13 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of alarm events +Minimum: 0 +Maximum: 2147483647 + |
+
data_list + |
+Array of EventManagementResponseInfo objects + |
+Event list +Array Length: 0 - 1000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
event_id + |
+String + |
+Event ID + |
+
event_class_id + |
+String + |
+Event category. Its value can be: +
|
+
event_type + |
+Integer + |
+Intrusion type. Its value can be: +
|
+
event_name + |
+String + |
+Event name + |
+
severity + |
+String + |
+Threat level. Its value can be: +
|
+
container_name + |
+String + |
+Container instance name. This API is available only for container alarms. + |
+
image_name + |
+String + |
+Image name. This API is available only for container alarms. + |
+
host_name + |
+String + |
+Server name + |
+
host_id + |
+String + |
+Host ID + |
+
private_ip + |
+String + |
+Server private IP address + |
+
public_ip + |
+String + |
+Elastic IP address + |
+
os_type + |
+String + |
+OS type. Its value can be: +
|
+
host_status + |
+String + |
+Server status. The options are as follows: +
|
+
agent_status + |
+String + |
+Agent status. Its value can be: +
|
+
protect_status + |
+String + |
+Protection status. Its value can be: +
|
+
asset_value + |
+String + |
+Asset importance. The options are as follows: +
|
+
attack_phase + |
+String + |
+Attack phase. Its value can be: +
|
+
attack_tag + |
+String + |
+Attack tag. Its value can be: +
|
+
occur_time + |
+Integer + |
+Occurrence time, accurate to milliseconds. + |
+
handle_time + |
+Integer + |
+Handling time, in milliseconds. This API is available only for handled alarms. + |
+
handle_status + |
+String + |
+Processing status. Its value can be: +
|
+
handle_method + |
+String + |
+Handling method. This API is available only for handled alarms. The options are as follows: +
|
+
handler + |
+String + |
+Remarks. This API is available only for handled alarms. + |
+
operate_accept_list + |
+Array of strings + |
+Supported processing operation + |
+
operate_detail_list + |
+Array of EventDetailResponseInfo objects + |
+Operation details list (not displayed on the page) +Array Length: 0 - 100 + |
+
forensic_info + |
+Object + |
+Attack information, in JSON format. + |
+
resource_info + |
+EventResourceResponseInfo object + |
+Resource information + |
+
geo_info + |
+Object + |
+Geographical location, in JSON format. + |
+
malware_info + |
+Object + |
+Malware information, in JSON format. + |
+
network_info + |
+Object + |
+Network information, in JSON format. + |
+
app_info + |
+Object + |
+Application information, in JSON format. + |
+
system_info + |
+Object + |
+System information, in JSON format. + |
+
extend_info + |
+Object + |
+Extended event information, in JSON format + |
+
recommendation + |
+String + |
+Handling suggestions + |
+
process_info_list + |
+Array of EventProcessResponseInfo objects + |
+Process information list +Array Length: 0 - 100 + |
+
user_info_list + |
+Array of EventUserResponseInfo objects + |
+User information list +Array Length: 0 - 100 + |
+
file_info_list + |
+Array of EventFileResponseInfo objects + |
+File information list +Array Length: 0 - 100 + |
+
event_details + |
+String + |
+Brief description of the event. +Minimum: 0 +Maximum: 204800 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
agent_id + |
+String + |
+Agent ID + |
+
process_pid + |
+Integer + |
+Process ID + |
+
is_parent + |
+Boolean + |
+Whether a process is a parent process + |
+
file_hash + |
+String + |
+File hash + |
+
file_path + |
+String + |
+File path + |
+
file_attr + |
+String + |
+File attribute + |
+
private_ip + |
+String + |
+Server private IP address + |
+
login_ip + |
+String + |
+Login source IP address + |
+
login_user_name + |
+String + |
+Login username + |
+
keyword + |
+String + |
+Alarm event keyword, which is used only for the alarm whitelist. + |
+
hash + |
+String + |
+Alarm event hash, which is used only for the alarm whitelist. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
domain_id + |
+String + |
+User account ID + |
+
project_id + |
+String + |
+Project ID + |
+
enterprise_project_id + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. + |
+
region_name + |
+String + |
+Region name + |
+
vpc_id + |
+String + |
+VPC ID + |
+
cloud_id + |
+String + |
+ECS ID + |
+
vm_name + |
+String + |
+VM name + |
+
vm_uuid + |
+String + |
+Specifies the VM UUID, that is, the server ID. + |
+
container_id + |
+String + |
+Container ID + |
+
image_id + |
+String + |
+Image ID + |
+
image_name + |
+String + |
+Image name + |
+
host_attr + |
+String + |
+Host attribute + |
+
service + |
+String + |
+Service + |
+
micro_service + |
+String + |
+Microservice + |
+
sys_arch + |
+String + |
+System CPU architecture + |
+
os_bit + |
+String + |
+OS bit version + |
+
os_type + |
+String + |
+OS type + |
+
os_name + |
+String + |
+OS name + |
+
os_version + |
+String + |
+OS version + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
process_name + |
+String + |
+Process name + |
+
process_path + |
+String + |
+Process file path + |
+
process_pid + |
+Integer + |
+Process ID +Minimum: 0 +Maximum: 2147483647 + |
+
process_uid + |
+Integer + |
+Process user ID +Minimum: 0 +Maximum: 2147483647 + |
+
process_username + |
+String + |
+Process username + |
+
process_cmdline + |
+String + |
+Process file command line + |
+
process_filename + |
+String + |
+Process file name + |
+
process_start_time + |
+Long + |
+Process start time +Minimum: 0 +Maximum: 9223372036854775807 + |
+
process_gid + |
+Integer + |
+Process group ID +Minimum: 0 +Maximum: 2147483647 + |
+
process_egid + |
+Integer + |
+Valid process group ID +Minimum: 0 +Maximum: 2147483647 + |
+
process_euid + |
+Integer + |
+Valid process user ID +Minimum: 0 +Maximum: 2147483647 + |
+
parent_process_name + |
+String + |
+Parent process name + |
+
parent_process_path + |
+String + |
+Parent process file path + |
+
parent_process_pid + |
+Integer + |
+Parent process ID +Minimum: 0 +Maximum: 2147483647 + |
+
parent_process_uid + |
+Integer + |
+Parent process user ID +Minimum: 0 +Maximum: 2147483647 + |
+
parent_process_cmdline + |
+String + |
+Parent process file command line + |
+
parent_process_filename + |
+String + |
+Parent process file name + |
+
parent_process_start_time + |
+Long + |
+Parent process start time +Minimum: 0 +Maximum: 9223372036854775807 + |
+
parent_process_gid + |
+Integer + |
+Parent process group ID +Minimum: 0 +Maximum: 2147483647 + |
+
parent_process_egid + |
+Integer + |
+Valid parent process group ID +Minimum: 0 +Maximum: 2147483647 + |
+
parent_process_euid + |
+Integer + |
+Valid parent process user ID +Minimum: 0 +Maximum: 2147483647 + |
+
child_process_name + |
+String + |
+Subprocess name + |
+
child_process_path + |
+String + |
+Subprocess file path + |
+
child_process_pid + |
+Integer + |
+Subprocess ID +Minimum: 0 +Maximum: 2147483647 + |
+
child_process_uid + |
+Integer + |
+Subprocess user ID +Minimum: 0 +Maximum: 2147483647 + |
+
child_process_cmdline + |
+String + |
+Subprocess file command line + |
+
child_process_filename + |
+String + |
+Subprocess file name + |
+
child_process_start_time + |
+Long + |
+Subprocess start time +Minimum: 0 +Maximum: 9223372036854775807 + |
+
child_process_gid + |
+Integer + |
+Subprocess group ID +Minimum: 0 +Maximum: 2147483647 + |
+
child_process_egid + |
+Integer + |
+Valid subprocess group ID +Minimum: 0 +Maximum: 2147483647 + |
+
child_process_euid + |
+Integer + |
+Valid subprocess user ID +Minimum: 0 +Maximum: 2147483647 + |
+
virt_cmd + |
+String + |
+Virtualization command + |
+
virt_process_name + |
+String + |
+Virtualization process name + |
+
escape_mode + |
+String + |
+Escape mode + |
+
escape_cmd + |
+String + |
+Commands executed after escape + |
+
process_hash + |
+String + |
+Process startup file hash + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
user_id + |
+Integer + |
+User UID +Minimum: 0 +Maximum: 2147483647 + |
+
user_gid + |
+Integer + |
+User GID +Minimum: 0 +Maximum: 2147483647 + |
+
user_name + |
+String + |
+User name + |
+
user_group_name + |
+String + |
+User group name + |
+
user_home_dir + |
+String + |
+User home directory + |
+
login_ip + |
+String + |
+User login IP address + |
+
service_type + |
+String + |
+Service type. The options are as follows: +
|
+
service_port + |
+Integer + |
+Login service port +Minimum: 0 +Maximum: 2147483647 + |
+
login_mode + |
+Integer + |
+Login mode +Minimum: 0 +Maximum: 2147483647 + |
+
login_last_time + |
+Long + |
+Last login time +Minimum: 0 +Maximum: 9223372036854775807 + |
+
login_fail_count + |
+Integer + |
+Number of failed login attempts +Minimum: 0 +Maximum: 2147483647 + |
+
pwd_hash + |
+String + |
+Password hash + |
+
pwd_with_fuzzing + |
+String + |
+Masked password + |
+
pwd_used_days + |
+Integer + |
+Password age (days) +Minimum: 0 +Maximum: 2147483647 + |
+
pwd_min_days + |
+Integer + |
+Minimum password validity period +Minimum: 0 +Maximum: 2147483647 + |
+
pwd_max_days + |
+Integer + |
+Maximum password validity period +Minimum: 0 +Maximum: 2147483647 + |
+
pwd_warn_left_days + |
+Integer + |
+Advance warning of password expiration (days) +Minimum: 0 +Maximum: 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
file_path + |
+String + |
+File path + |
+
file_alias + |
+String + |
+File alias + |
+
file_size + |
+Integer + |
+File size +Minimum: 0 +Maximum: 2147483647 + |
+
file_mtime + |
+Long + |
+Time when a file was last modified +Minimum: 0 +Maximum: 9223372036854775807 + |
+
file_atime + |
+Long + |
+Time when a file was last accessed +Minimum: 0 +Maximum: 9223372036854775807 + |
+
file_ctime + |
+Long + |
+Time when the status of a file was last changed +Minimum: 0 +Maximum: 9223372036854775807 + |
+
file_hash + |
+String + |
+The hash value calculated using the SHA256 algorithm. + |
+
file_md5 + |
+String + |
+File MD5 + |
+
file_sha256 + |
+String + |
+File SHA256 + |
+
file_type + |
+String + |
+File type + |
+
file_content + |
+String + |
+File content + |
+
file_attr + |
+String + |
+File attribute + |
+
file_operation + |
+Integer + |
+File operation type +Minimum: 0 +Maximum: 2147483647 + |
+
file_action + |
+String + |
+File action + |
+
file_change_attr + |
+String + |
+Old/New attribute + |
+
file_new_path + |
+String + |
+New file path + |
+
file_desc + |
+String + |
+File description + |
+
file_key_word + |
+String + |
+File keyword + |
+
is_dir + |
+Boolean + |
+Whether it is a directory + |
+
fd_info + |
+String + |
+File handle information + |
+
fd_count + |
+Integer + |
+Number of file handles +Minimum: 0 +Maximum: 2147483647 + |
+
Query the first 50 unprocessed server events whose enterprise project is xxx.
+GET https://{endpoint}/v5/{project_id}/event/events?offset=0&limit=50&handle_status=unhandled&category=host&enterprise_project_id=xxx
+Status code: 200
+intrusion list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "attack_phase" : "exploit",
+ "attack_tag" : "abnormal_behavior",
+ "event_class_id" : "lgin_1002",
+ "event_id" : "d8a12cf7-6a43-4cd6-92b4-aabf1e917",
+ "event_name" : "different locations",
+ "event_type" : 4004,
+ "forensic_info" : {
+ "country" : "Country/Region",
+ "city" : "State/Province",
+ "ip" : "127.0.0.1",
+ "user" : "zhangsan",
+ "sub_division" : "City",
+ "city_id" : 3110
+ },
+ "handle_status" : "unhandled",
+ "host_name" : "xxx",
+ "occur_time" : 1661593036627,
+ "operate_accept_list" : [ "ignore" ],
+ "operate_detail_list" : [ {
+ "agent_id" : "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8",
+ "file_hash" : "e8b50f0b91e3dce0885ccc5902846b139d28108a0a7976c9b8d43154c5dbc44d",
+ "file_path" : "/usr/test",
+ "process_pid" : 3123,
+ "file_attr" : 33261,
+ "keyword" : "file_path=/usr/test",
+ "hash" : "e8b50f0b91e3dce0885ccc5902846b139d28108a0a7976c9b8d43154c5dbc44d",
+ "login_ip" : "127.0.0.1",
+ "private_ip" : "127.0.0.2",
+ "login_user_name" : "root",
+ "is_parent" : false
+ } ],
+ "private_ip" : "127.0.0.1",
+ "resource_info" : {
+ "region_name" : "",
+ "project_id" : "",
+ "enterprise_project_id" : "0",
+ "os_type" : "Linux",
+ "os_version" : "2.5",
+ "vm_name" : "",
+ "vm_uuid" : "71a15ecc",
+ "cloud_id" : ""
+ },
+ "severity" : "Medium",
+ "extend_info" : "",
+ "os_type" : "Linux",
+ "agent_status" : "online",
+ "asset_value" : "common",
+ "protect_status" : "opened",
+ "host_status" : "ACTIVE",
+ "event_details" : "file_path:/root/test",
+ "user_info_list" : [ {
+ "login_ip" : "",
+ "service_port" : 22,
+ "service_type" : "ssh",
+ "user_name" : "zhangsan",
+ "login_mode" : 0,
+ "login_last_time" : 1661593024,
+ "login_fail_count" : 0
+ } ]
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+intrusion list + |
+
See Error Codes.
+This API is used to obtain the account change history.
+GET /v5/{project_id}/asset/user/change-history
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
user_name + |
+No + |
+String + |
+Username +Minimum: 1 +Maximum: 128 + |
+
host_id + |
+No + |
+String + |
+Server ID +Minimum: 1 +Maximum: 128 + |
+
root_permission + |
+No + |
+Boolean + |
+Whether the user has root permissions +
|
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 1 +Maximum: 128 + |
+
private_ip + |
+No + |
+String + |
+Server private IP address +Minimum: 1 +Maximum: 128 + |
+
change_type + |
+No + |
+String + |
+Account change type. The options are as follows: +
|
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 100 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 10000 +Default: 0 + |
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
start_time + |
+No + |
+Long + |
+Start time of a change. Its value is a 13-digit timestamp. +Minimum: 0 +Maximum: 4070880000000 + |
+
end_time + |
+No + |
+Long + |
+End time of a change. Its value is a 13-digit timestamp. +Minimum: 0 +Maximum: 4070880000000 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of changed accounts +Minimum: 0 +Maximum: 10000000 + |
+
data_list + |
+Array of UserChangeHistoryResponseInfo objects + |
+Account change history +Array Length: 0 - 200 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
agent_id + |
+String + |
+Agent ID +Minimum: 1 +Maximum: 128 + |
+
change_type + |
+String + |
+Change type. Its value can be: +
Minimum: 1 +Maximum: 128 + |
+
host_id + |
+String + |
+Host ID +Minimum: 1 +Maximum: 128 + |
+
host_name + |
+String + |
+Server name +Minimum: 1 +Maximum: 128 + |
+
private_ip + |
+String + |
+Server private IP address +Minimum: 1 +Maximum: 128 + |
+
login_permission + |
+Boolean + |
+Whether the user has the login permission + |
+
root_permission + |
+Boolean + |
+Whether the user has root permissions + |
+
user_group_name + |
+String + |
+User group name +Minimum: 1 +Maximum: 128 + |
+
user_home_dir + |
+String + |
+User home directory +Minimum: 1 +Maximum: 128 + |
+
shell + |
+String + |
+User startup shell +Minimum: 1 +Maximum: 128 + |
+
user_name + |
+String + |
+Account name +Minimum: 1 +Maximum: 128 + |
+
expire_time + |
+Long + |
+Expiration time, which is a timestamp. The default unit is millisecond. +Minimum: 0 +Maximum: 4070880000000 + |
+
recent_scan_time + |
+Long + |
+Time when an account is added, modified, or deleted. +Minimum: 0 +Maximum: 4070880000000 + |
+
The first 10 account change records whose start time is 1700446129130 and end time is 1701050929130 are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/user/change-history?start_time=1700446129130&end_time=1701050929130
+Status code: 200
+account change history
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "agent_id" : "0bf792d910xxxxxxxxxxx52cb7e63exxx",
+ "host_id" : "13xxxxxxxece69",
+ "private_ip" : "192.168.0.1",
+ "host_name" : "test",
+ "user_home_dir" : "/test",
+ "login_permission" : false,
+ "recent_scan_time" : 1667039707730,
+ "expire_time" : 1667039707730,
+ "root_permission" : false,
+ "shell" : "/sbin/nologin",
+ "user_group_name" : "bin",
+ "user_name" : "bin",
+ "change_type" : "ADD"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+account change history + |
+
See Error Codes.
+This API is used to check account information in asset fingerprints.
+GET /v5/{project_id}/asset/user/statistics
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
user_name + |
+No + |
+String + |
+Account name. It must comply with the Windows file naming rules. The value can contain letters, digits, underscores (_), and the following special characters: !@.-. +Minimum: 1 +Maximum: 128 + |
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 128 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of accounts +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of UserStatisticInfoResponseInfo objects + |
+Account statistics list +Array Length: 0 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
user_name + |
+String + |
+Account name. It must comply with the Windows file naming rules. The value can contain letters, digits, underscores (_), and the following special characters: !@.-. +Minimum: 1 +Maximum: 128 + |
+
num + |
+Integer + |
+Number of servers of the account +Minimum: 0 +Maximum: 10000 + |
+
The first 10 accounts are queried by default.
+GET https://{endpoint}/v5/{project_id}/asset/user/statistics
+Status code: 200
+Number of servers having the account
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "user_name" : "bin",
+ "num" : 5
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Number of servers having the account + |
+
See Error Codes.
+This API is used to query the server list of an account.
+GET /v5/{project_id}/asset/users
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
host_id + |
+No + |
+String + |
+Host ID +Minimum: 0 +Maximum: 128 + |
+
user_name + |
+No + |
+String + |
+Account name +Minimum: 0 +Maximum: 32 + |
+
host_name + |
+No + |
+String + |
+Host name +Minimum: 0 +Maximum: 128 + |
+
private_ip + |
+No + |
+String + |
+Server private IP address +Minimum: 0 +Maximum: 128 + |
+
login_permission + |
+No + |
+Boolean + |
+Whether login is allowed. +
|
+
root_permission + |
+No + |
+Boolean + |
+Whether the user has root permissions +
|
+
user_group + |
+No + |
+String + |
+Server user group +Minimum: 0 +Maximum: 128 + |
+
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 128 + |
+
limit + |
+No + |
+Integer + |
+Number of records on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Total number of accounts +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of UserResponseInfo objects + |
+Account information list +Array Length: 0 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
agent_id + |
+String + |
+Agent ID +Minimum: 1 +Maximum: 128 + |
+
host_id + |
+String + |
+Host ID +Minimum: 1 +Maximum: 128 + |
+
host_name + |
+String + |
+Server name +Minimum: 1 +Maximum: 128 + |
+
host_ip + |
+String + |
+Server IP address +Minimum: 1 +Maximum: 128 + |
+
user_name + |
+String + |
+Username +Minimum: 1 +Maximum: 128 + |
+
login_permission + |
+Boolean + |
+Whether the user has the login permission + |
+
root_permission + |
+Boolean + |
+Whether the user has root permissions + |
+
user_group_name + |
+String + |
+User group name +Minimum: 1 +Maximum: 128 + |
+
user_home_dir + |
+String + |
+User home directory +Minimum: 1 +Maximum: 256 + |
+
shell + |
+String + |
+User startup shell +Minimum: 1 +Maximum: 128 + |
+
recent_scan_time + |
+Long + |
+Latest scan time, in ms. +Minimum: 0 +Maximum: 4070880000000 + |
+
Query servers list whose account is daemon by default.
+GET https://{endpoint}/v5/{project_id}/asset/users?user_name=daemon
+Status code: 200
+account information list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "agent_id" : "0bf792d910xxxxxxxxxxx52cb7e63exxx",
+ "host_id" : "13xxxxxxxece69",
+ "host_ip" : "192.168.0.1",
+ "host_name" : "test",
+ "login_permission" : false,
+ "recent_scan_time" : 1667039707730,
+ "root_permission" : false,
+ "shell" : "/sbin/nologin",
+ "user_group_name" : "bin",
+ "user_home_dir" : "/bin",
+ "user_name" : "bin"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+account information list + |
+
See Error Codes.
+This API is used to query the servers affected by a vulnerability.
+GET /v5/{project_id}/vulnerability/hosts
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 128 + |
+
vul_id + |
+Yes + |
+String + |
+Vulnerability ID +Minimum: 0 +Maximum: 64 + |
+
type + |
+Yes + |
+String + |
+Vulnerability type. Its value can be: +
|
+
host_name + |
+No + |
+String + |
+Affected server name +Minimum: 0 +Maximum: 256 + |
+
host_ip + |
+No + |
+String + |
+IP address of the affected server +Minimum: 0 +Maximum: 128 + |
+
status + |
+No + |
+String + |
+Vulnerability status. +
|
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 10 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Integer + |
+Number of affected servers +Minimum: 0 +Maximum: 10000 + |
+
data_list + |
+Array of VulHostInfo objects + |
+List of affected ECSs +Array Length: 1 - 10000 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
host_id + |
+String + |
+ID of the server affected by the vulnerability +Minimum: 1 +Maximum: 128 + |
+
severity_level + |
+String + |
+Risk level. +
|
+
host_name + |
+String + |
+Affected server name +Minimum: 1 +Maximum: 256 + |
+
host_ip + |
+String + |
+IP address of the affected server +Minimum: 1 +Maximum: 256 + |
+
cve_num + |
+Integer + |
+Vulnerability CVEs +Minimum: 0 +Maximum: 10000 + |
+
cve_id_list + |
+Array of strings + |
+The CVE ID list corresponding to the vulnerability +Minimum: 1 +Maximum: 64 +Array Length: 1 - 10000 + |
+
status + |
+String + |
+Vulnerability status. +
|
+
repair_cmd + |
+String + |
+Command line to be executed to fix the vulnerability (This field is available only for Linux vulnerabilities.) +Minimum: 1 +Maximum: 256 + |
+
Query the first 10 records in the list of servers with EulerOS-SA-2021-1894 vulnerability.
+GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/hosts?vul_id=EulerOS-SA-2021-1894&offset=0&limit=10
+Status code: 200
+Vul host info list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "host_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+ "severity_level" : "Low",
+ "host_name" : "ecs",
+ "host_ip" : "xxx.xxx.xxx.xxx",
+ "cve_num" : 1,
+ "cve_id_list" : [ "CVE-2022-1664" ],
+ "status" : "vul_status_ignored",
+ "repair_cmd" : "zypper update update-alternatives"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Vul host info list + |
+
See Error Codes.
+This API is used to query the list of detected vulnerabilities.
+GET /v5/{project_id}/vulnerability/vulnerabilities
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 256 + |
+
type + |
+No + |
+String + |
+Vulnerability type. Its value can be: -linux_vul -windows_vul -web_cms +Minimum: 0 +Maximum: 32 + |
+
vul_id + |
+No + |
+String + |
+Vulnerability ID +Minimum: 0 +Maximum: 256 + |
+
vul_name + |
+No + |
+String + |
+Vulnerability name +Minimum: 0 +Maximum: 256 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page +Minimum: 0 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Long + |
+Total number of vulnerabilities +Minimum: 0 +Maximum: 2147483647 + |
+
data_list + |
+Array of VulInfo objects + |
+Software vulnerability list +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
vul_name + |
+String + |
+Vulnerability name +Minimum: 0 +Maximum: 256 + |
+
vul_id + |
+String + |
+Vulnerability ID +Minimum: 0 +Maximum: 64 + |
+
label_list + |
+Array of strings + |
+Vulnerability tag +Minimum: 0 +Maximum: 65534 +Array Length: 0 - 2147483647 + |
+
repair_necessity + |
+String + |
+Repair necessity +
|
+
severity_level + |
+String + |
+Severity +
|
+
host_num + |
+Integer + |
+Number of affected servers +Minimum: 0 +Maximum: 2147483647 + |
+
unhandle_host_num + |
+Integer + |
+Number of unprocessed servers, excluding ignored and fixed servers. +Minimum: 0 +Maximum: 2147483647 + |
+
scan_time + |
+Long + |
+Last scanned, in ms. +Minimum: 0 +Maximum: 9223372036854775807 + |
+
solution_detail + |
+String + |
+Vulnerability fixing guide +Minimum: 0 +Maximum: 65534 + |
+
url + |
+String + |
+Vulnerability URL +Minimum: 0 +Maximum: 2083 + |
+
description + |
+String + |
+Vulnerability description +Minimum: 0 +Maximum: 65534 + |
+
type + |
+String + |
+Vulnerability type. Its value can be:-linux_vul -windows_vul -web_cms + |
+
host_id_list + |
+Array of strings + |
+List of servers that can handle the vulnerability +Minimum: 0 +Maximum: 128 +Array Length: 0 - 2147483647 + |
+
hosts_num + |
+VulnerabilityHostNumberInfo object + |
+Number of affected servers + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
important + |
+Integer + |
+Number of important servers +Minimum: 0 +Maximum: 10000 + |
+
common + |
+Integer + |
+Number of common servers +Minimum: 0 +Maximum: 10000 + |
+
test + |
+Integer + |
+Number of test servers +Minimum: 0 +Maximum: 10000 + |
+
Query the first 10 records in the vulnerability list whose project_id is 2b31ed520xxxxxxebedb6e57xxxxxxxx.
+GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/vulnerabilities?offset=0&limit=10
+Status code: 200
+vulnerability list
+{
+ "total_num" : 1,
+ "data_list" : [ {
+ "description" : "It was discovered that FreeType did not correctly handle certain malformed font files. If a user were tricked into using a specially crafted font file, a remote attacker could cause FreeType to crash, or possibly execute arbitrary code.",
+ "host_id_list" : [ "caa958ad-a481-4d46-b51e-6861b8864515" ],
+ "host_num" : 1,
+ "scan_time" : 1661752185836,
+ "severity_level" : "Critical",
+ "repair_necessity" : "Critical",
+ "solution_detail" : "To upgrade the affected software",
+ "type" : "linux_vul",
+ "unhandle_host_num" : 0,
+ "url" : "https://ubuntu.com/security/CVE-2022-27405",
+ "vul_id" : "USN-5528-1",
+ "vul_name" : "USN-5528-1: FreeType vulnerabilities"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+vulnerability list + |
+
See Error Codes.
+This API is used to query the list of weak password detection results.
+GET /v5/{project_id}/baseline/weak-password-users
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 20 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
host_name + |
+No + |
+String + |
+Server name +Minimum: 0 +Maximum: 256 + |
+
host_ip + |
+No + |
+String + |
+Server IP address +Minimum: 0 +Maximum: 256 + |
+
user_name + |
+No + |
+String + |
+Name of the account using a weak password +Minimum: 0 +Maximum: 32 + |
+
host_id + |
+No + |
+String + |
+Host ID. If this parameter is not specified, all hosts of a user are queried. +Minimum: 0 +Maximum: 64 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 0 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 2097152 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
total_num + |
+Long + |
+Total number of weak passwords +Minimum: 0 +Maximum: 2147483647 + |
+
data_list + |
+Array of WeakPwdListInfoResponseInfo objects + |
+Weak password list +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
host_id + |
+String + |
+Host ID +Minimum: 0 +Maximum: 64 + |
+
host_name + |
+String + |
+Server name +Minimum: 0 +Maximum: 256 + |
+
host_ip + |
+String + |
+Server IP address (private IP address) +Minimum: 0 +Maximum: 256 + |
+
weak_pwd_accounts + |
+Array of WeakPwdAccountInfoResponseInfo objects + |
+List of accounts with weak passwords +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
user_name + |
+String + |
+Name of accounts with weak passwords +Minimum: 0 +Maximum: 32 + |
+
service_type + |
+String + |
+Account type. The options are as follows: +
|
+
duration + |
+Integer + |
+Validity period of a weak password, in days. +Minimum: 0 +Maximum: 2147483647 + |
+
Query the weak password of servers whose enterprise project ID is xxx. Data on the first page (the first 10 records) is returned by default.
+GET https://{endpoint}/v5/{project_id}/baseline/weak-password-users?enterprise_project_id=xxx
+Status code: 200
+weak password check result
+{
+ "total_num" : 2,
+ "data_list" : [ {
+ "host_id" : "caa958adxxxxxxa481",
+ "host_name" : "ubuntu1",
+ "host_ip" : "192.168.0.8",
+ "weak_pwd_accounts" : [ {
+ "user_name" : "localhost1",
+ "service_type" : "system",
+ "duration" : 2147483647
+ } ]
+ }, {
+ "host_id" : "caa958adxxxxxxa482",
+ "host_name" : "ubuntu2",
+ "host_ip" : "192.168.0.9",
+ "weak_pwd_accounts" : [ {
+ "user_name" : "localhost2",
+ "service_type" : "system",
+ "duration" : 2147483647
+ } ]
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+weak password check result + |
+
See Error Codes.
+This API is used to enable or disable dynamic WTP.
+POST /v5/{project_id}/webtamper/rasp/status
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Content-Type + |
+No + |
+String + |
+Default value: application/json; charset=utf-8 +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
host_id_list + |
+No + |
+Array of strings + |
+HostId list +Minimum: 0 +Maximum: 128 +Array Length: 0 - 20000 + |
+
status + |
+No + |
+Boolean + |
+Dynamic WTP status + |
+
None
+Enable dynamic WTP for servers a and b.
+POST https://{endpoint}/v5/{project_id}/webtamper/rasp/status
+
+{
+ "host_id_list" : [ "a", "b" ],
+ "status" : true
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+successful response + |
+
See Error Codes.
+This API is used to enable or disable WTP.
+POST /v5/{project_id}/webtamper/static/status
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Content-Type + |
+No + |
+String + |
+Default value: application/json; charset=utf-8 +Minimum: 0 +Maximum: 128 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
status + |
+Yes + |
+Boolean + |
+Whether to enable the function. true: The function is enabled. false: The function is disabled. + |
+
host_id_list + |
+Yes + |
+Array of strings + |
+The value in the array is server ID and the server ID cannot be empty. +Minimum: 0 +Maximum: 128 +Array Length: 1 - 20000 + |
+
resource_id + |
+No + |
+String + |
+Resource ID +Minimum: 0 +Maximum: 64 + |
+
None
+Enable WTP, set the target server IDs to a and b, and pay for the yearly/monthly billing mode.
+POST https://{endpoint}/v5/{project_id}/webtamper/static/status
+
+{
+ "status" : true,
+ "host_id_list" : [ "a", "b" ],
+ "resource_id" : "aaxxx",
+ "charging_mode" : "on_demand"
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+successful response + |
+
See Error Codes.
+This API is used to collect statistics on assets, such as accounts, ports, and processes.
+GET /v5/{project_id}/asset/statistics
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 128 + |
+
host_id + |
+No + |
+String + |
+Host ID +Minimum: 1 +Maximum: 128 + |
+
category + |
+No + |
+String + |
+Type. The default value is host. The options are as follows: +
|
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 4096 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
account_num + |
+Long + |
+Number of server accounts +Minimum: 0 +Maximum: 2147483647 + |
+
port_num + |
+Long + |
+Number of open ports +Minimum: 0 +Maximum: 2147483647 + |
+
process_num + |
+Long + |
+Number of processes +Minimum: 0 +Maximum: 2147483647 + |
+
app_num + |
+Long + |
+Pieces of software +Minimum: 0 +Maximum: 2147483647 + |
+
auto_launch_num + |
+Long + |
+Number of auto-startup processes +Minimum: 0 +Maximum: 2147483647 + |
+
web_framework_num + |
+Long + |
+Number of web frameworks +Minimum: 0 +Maximum: 2147483647 + |
+
web_site_num + |
+Long + |
+Number of websites +Minimum: 0 +Maximum: 2147483647 + |
+
jar_package_num + |
+Long + |
+Number of JAR packages +Minimum: 0 +Maximum: 2147483647 + |
+
kernel_module_num + |
+Long + |
+Number of kernel modules +Minimum: 0 +Maximum: 2147483647 + |
+
web_service_num + |
+Long + |
+Number of web services +Minimum: 0 +Maximum: 2147483647 + |
+
web_app_num + |
+Long + |
+Number of web applications +Minimum: 0 +Maximum: 2147483647 + |
+
database_num + |
+Long + |
+Number of databases +Minimum: 0 +Maximum: 2147483647 + |
+
This API is used to query the fingerprint information, accounts, ports, and processes of a server.
+GET https://{endpoint}/v5/{project_id}/asset/statistics?category=host
+Status code: 200
+Asset statistic info
+{
+ "account_num" : 5,
+ "port_num" : 5,
+ "process_num" : 5,
+ "app_num" : 5,
+ "auto_launch_num" : 5,
+ "web_framework_num" : 5,
+ "web_site_num" : 5,
+ "jar_package_num" : 5,
+ "kernel_module_num" : 5,
+ "database_num" : 1,
+ "web_app_num" : 8,
+ "web_service_num" : 2
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Asset statistic info + |
+
See Error Codes.
+This API is used to query the report of a check item in a security configuration check.
+GET /v5/{project_id}/baseline/check-rule/detail
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 20 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
check_name + |
+Yes + |
+String + |
+Name of the configuration check (baseline), for example, SSH, CentOS 7, and Windows. +Minimum: 0 +Maximum: 255 + |
+
check_type + |
+Yes + |
+String + |
+Baseline type. You can obtain the value by calling API /v5/{project_id}/baseline/risk-configs. Note that the values for check_type and check_name are the same for Linux servers. For example, they can both be set to SSH or CentOS 7. For Windows servers, the values for check_type and check_name are different. For example, check_type can be set to Windows Server 2019 R2 or Windows Server 2016 R2, while check_name can be set to Windows. +Minimum: 0 +Maximum: 255 + |
+
check_rule_id + |
+Yes + |
+String + |
+Check item ID, which can be obtained from the return data of this API: /v5/{project_id}/baseline/risk-config/{check_name}/check-rules +Minimum: 0 +Maximum: 255 + |
+
standard + |
+Yes + |
+String + |
+hw_standard: Cloud security practice standard + |
+
host_id + |
+No + |
+String + |
+Host ID +Minimum: 0 +Maximum: 64 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 2097152 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
description + |
+String + |
+Description of the current check item (detection rule). +Minimum: 0 +Maximum: 2048 + |
+
reference + |
+String + |
+Basis for the check item (rule) setting +Minimum: 0 +Maximum: 255 + |
+
audit + |
+String + |
+Audit description of the check item (rule) +Minimum: 0 +Maximum: 65534 + |
+
remediation + |
+String + |
+Modification suggestions for the check item (rule) +Minimum: 0 +Maximum: 65534 + |
+
check_info_list + |
+Array of CheckRuleCheckCaseResponseInfo objects + |
+Test cases +Array Length: 0 - 2147483647 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
check_description + |
+String + |
+Test case description +Minimum: 0 +Maximum: 65534 + |
+
current_value + |
+String + |
+Current result +Minimum: 0 +Maximum: 65534 + |
+
suggest_value + |
+String + |
+Expected result +Minimum: 0 +Maximum: 65534 + |
+
This API is used to query the report of the configuration check items whose baseline name is SSH, check item ID is 1.12, check standard is cloud security practice standard, and enterprise project ID is xxx.
+GET https://{endpoint}/v5/{project_id}/baseline/check-rule/detail?standard=hw_standard&enterprise_project_id=xxx&check_name=SSH&check_type=SSH&check_rule_id=1.12
+Status code: 200
+configuration item check report
+{
+ "audit" : "Run the following commands and verify that ClientAliveInterval is smaller than 300 and ClientAliveCountMax is 3 or less: \n#grep '^ClientAliveInterval' /etc/ssh/sshd_config\nClientAliveInterval 300(default is 0) \n#grep '^ClientAliveCountMax' /etc/ssh/sshd_config\nClientAliveCountMax 0(default is 3)",
+ "description" : "The two options ClientAliveInterval and ClientAliveCountMax control the timeout of SSH sessions. The ClientAliveInterval parameter sets a timeout interval in seconds after which if no data has been received from the client, sshd will send a message through the encrypted channel to request a response from the client. The ClientAliveCountMax parameter sets the number of client alive messages which may be sent without sshd receiving any messages back from the client. For example, if the ClientAliveInterval is set to 15s and the ClientAliveCountMax is set to 3, unresponsive SSH clients will be disconnected after approximately 45s.",
+ "reference" : "",
+ "remediation" : "Edit the /etc/ssh/sshd_config file to set the parameter as follows: \nClientAliveInterval 300 \nClientAliveCountMax 0"
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+configuration item check report + |
+
See Error Codes.
+This API is used to query the check result of a specified security configuration item.
+GET /v5/{project_id}/baseline/risk-config/{check_name}/detail
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 20 +Maximum: 64 + |
+
check_name + |
+Yes + |
+String + |
+Name of the configuration check (baseline), for example, SSH, CentOS 7, and Windows. +Minimum: 0 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 0 +Maximum: 64 + |
+
standard + |
+Yes + |
+String + |
+hw_standard: Cloud security practice standard + |
+
host_id + |
+No + |
+String + |
+Server ID. If this parameter is not specified, all the servers of the user are queried. +Minimum: 0 +Maximum: 64 + |
+
limit + |
+No + |
+Integer + |
+Number of records displayed on each page. +Minimum: 0 +Maximum: 200 +Default: 10 + |
+
offset + |
+No + |
+Integer + |
+Offset, which specifies the start position of the record to be returned. +Minimum: 0 +Maximum: 2000000 +Default: 0 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 32 +Maximum: 2097152 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
severity + |
+String + |
+Risk level. Its value can be: +
|
+
check_type + |
+String + |
+Configuration check (baseline) type, for example, SSH, CentOS 7, Windows Server 2019 R2, Windows Server 2016 R2 and MySQL5-Windows. +Minimum: 0 +Maximum: 256 + |
+
check_type_desc + |
+String + |
+Description of the baseline type, including the standards for the check items and the issues that can be audited. +Minimum: 0 +Maximum: 65534 + |
+
check_rule_num + |
+Integer + |
+Indicates the total number of check items of the current configuration check (baseline) type. For example, if the standard type of the SSH baseline is hw_standard, server security provides 17 check items, but only five check items of the SSH baseline are detected on all servers. Therefore, the value of check_rule_num is 5. All check items are checked on a server. The value of check_rule_num is 17. +Minimum: 0 +Maximum: 2147483647 + |
+
failed_rule_num + |
+Integer + |
+Number of failed check items. If a server fails to pass a check item in check_rule_num, the item is counted in failed_rule_num. +Minimum: 0 +Maximum: 2147483647 + |
+
passed_rule_num + |
+Integer + |
+Number of passed check items. If a server passes a check item in check_rule_num, the check item is counted in passed_rule_num. +Minimum: 0 +Maximum: 2147483647 + |
+
ignored_rule_num + |
+Integer + |
+Number of ignored check items. If a server ignores a check item in check_rule_num, the check item is counted in ignored_rule_num. +Minimum: 0 +Maximum: 2147483647 + |
+
host_num + |
+Long + |
+The number of servers on which the current baseline detection is performed. +Minimum: 0 +Maximum: 2147483647 + |
+
This API is used to query the configuration check list whose baseline name is SSH, check standard is cloud security practice standard, and enterprise project ID is xxx.
+GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/detail?standard=hw_standard&enterprise_project_id=xxx
+Status code: 200
+security configuration item check result
+{
+ "check_rule_num" : 17,
+ "check_type_desc" : "This policy checks the basic security configuration items of the SSH service to improve the security of the SSH service.",
+ "failed_rule_num" : 15,
+ "host_num" : 2,
+ "ignored_rule_num" : 1,
+ "passed_rule_num" : 14,
+ "severity" : "Medium"
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+security configuration item check result + |
+
See Error Codes.
+This API is used to disable ransomware prevention.
+POST /v5/{project_id}/ransomware/protection/close
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
host_id_list + |
+Yes + |
+Array of strings + |
+IDs of servers where ransomware protection needs to be disabled +Minimum: 0 +Maximum: 64 +Array Length: 0 - 20 + |
+
agent_id_list + |
+Yes + |
+Array of strings + |
+IDs of agents where ransomware prevention needs to be disabled +Minimum: 0 +Maximum: 64 +Array Length: 0 - 20 + |
+
close_protection_type + |
+Yes + |
+String + |
+Type of disabled protection. The options are as follows: +
|
+
None
+Disable ransomware protection for the server. The target server ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f, and the agent ID of the target server is c9bed5397db449ebdfba15e85fcfc36accee954daf5cab0528bab59bd8.
+POST https://{endpoint}/v5/{project_id}/ransomware/protection/close
+
+{
+ "close_protection_type" : "close_anti",
+ "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
+ "agent_id_list" : [ "c9bed5397db449ebdfba15e85fcfc36accee954daf5cab0528bab59bd8" ]
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Ransomware protection disabled. + |
+
See Error Codes.
+This API is used to change the protection status.
+POST /v5/{project_id}/host-management/protection
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
version + |
+No + |
+String + |
+HSS edition. Its value can be: +
|
+
charging_mode + |
+No + |
+String + |
+on_demand: pay-per-use + |
+
resource_id + |
+No + |
+String + |
+Instance ID +Minimum: 1 +Maximum: 128 + |
+
host_id_list + |
+No + |
+Array of strings + |
+Server list +Minimum: 1 +Maximum: 128 +Array Length: 0 - 2097152 + |
+
tags + |
+No + |
+Array of TagInfo objects + |
+Resource tag +Array Length: 0 - 2097152 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+No + |
+String + |
+Key. It can contain up to 128 Unicode characters. The key cannot be left blank. +Minimum: 1 +Maximum: 128 + |
+
value + |
+No + |
+String + |
+Value. Each tag value can contain a maximum of 255 Unicode characters. +Minimum: 1 +Maximum: 255 + |
+
None
+Switch the protection edition of the server whose ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f to the enterprise edition.
+{
+ "version" : "hss.version.enterprise",
+ "charging_mode" : "on_demand",
+ "resource_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
+ "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
+ "tags" : [ {
+ "key" : "Service",
+ "value" : "hss"
+ } ]
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+successful response + |
+
See Error Codes.
+This API is used to modify the backup policy associated with the vault
+PUT /v5/{project_id}/backup/policy
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enabled + |
+No + |
+Boolean + |
+Whether the policy is enabled. The default value is true. + |
+
policy_id + |
+Yes + |
+String + |
+Backup policy ID +Minimum: 1 +Maximum: 256 + |
+
operation_definition + |
+No + |
++ | +Scheduling parameter. + |
+
trigger + |
+No + |
+BackupTriggerRequestInfo object + |
+Time scheduling rule for the policy + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
day_backups + |
+No + |
+Integer + |
+Maximum number of retained daily backups. The latest backup of each day is saved in the long term. This parameter is not affected by the maximum number of retained backup. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 +Minimum: 0 +Maximum: 100 + |
+
max_backups + |
+No + |
+Integer + |
+Maximum number of automated backups that can be retained for an object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity limit is exceeded. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. Minimum value: 1. Maximum value: 99999. Default value: -1 +Minimum: -1 +Maximum: 99999 + |
+
month_backups + |
+No + |
+Integer + |
+Maximum number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter is not affected by the maximum number of retained backup. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 +Minimum: 0 +Maximum: 100 + |
+
retention_duration_days + |
+No + |
+Integer + |
+Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared even though the configured retention duration is exceeded. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently. Minimum value: 1. Maximum value: 99999. Default value: -1 +Minimum: -1 +Maximum: 99999 + |
+
timezone + |
+No + |
+String + |
+Time zone where the user is located, for example, UTC+08:00. Set this parameter only after you have configured any of the parameters day_backups, week_backups, month_backups, and year_backups. +Minimum: 0 +Maximum: 256 + |
+
week_backups + |
+No + |
+Integer + |
+Maximum number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. +Minimum: 0 +Maximum: 100 + |
+
year_backups + |
+No + |
+Integer + |
+Maximum number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 +Minimum: 0 +Maximum: 100 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
properties + |
+Yes + |
++ | +Time rule for the policy execution. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
pattern + |
+Yes + |
+Array of strings + |
+Scheduling rule A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, or SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. To start scheduling at 14:00 every day, the rule is as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'. +Minimum: 1 +Maximum: 256 +Array Length: 0 - 24 + |
+
None
+Modify the backup policy. The target backup policy ID is af4d08ad-2b60-4916-a5cf-8d6a23956dda.
+PUT https://{endpoint}/v5/{project_id}/backup/policy
+
+{
+ "enabled" : true,
+ "policy_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
+ "operation_definition" : {
+ "day_backups" : 0,
+ "max_backups" : -1,
+ "month_backups" : 0,
+ "retention_duration_days" : 5,
+ "timezone" : "UTC+08:00",
+ "week_backups" : 0,
+ "year_backups" : 0
+ },
+ "trigger" : {
+ "properties" : {
+ "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ]
+ }
+ }
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Modify a backup policy. + |
+
See Error Codes.
+This API is used to modify ransomware protection policies.
+PUT /v5/{project_id}/ransomware/protection/policy
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enterprise_project_id + |
+No + |
+String + |
+Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. +Default: 0 +Minimum: 1 +Maximum: 256 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. +Minimum: 1 +Maximum: 32768 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
policy_id + |
+Yes + |
+String + |
+Policy ID +Minimum: 0 +Maximum: 128 + |
+
policy_name + |
+Yes + |
+String + |
+Policy name +Minimum: 0 +Maximum: 128 + |
+
protection_mode + |
+Yes + |
+String + |
+Action. Its value can be: +
|
+
bait_protection_status + |
+Yes + |
+String + |
+Whether to enable honeypot protection. By default, the protection is enabled. Its value can be: +
|
+
protection_directory + |
+Yes + |
+String + |
+Protected directory. Separate multiple directories with semicolons (;). You can configure up to 20 directories. +Minimum: 1 +Maximum: 128 + |
+
protection_type + |
+Yes + |
+String + |
+Protected file type, for example, .docx, .txt, and .avi. +Minimum: 1 +Maximum: 128 + |
+
exclude_directory + |
+No + |
+String + |
+(Optional) Excluded directory. Separate multiple directories with semicolons (;). You can configure up to 20 directories. +Minimum: 1 +Maximum: 128 + |
+
agent_id_list + |
+No + |
+Array of strings + |
+Specifies the IDs of agents for which the ransomware protection policy is enabled. +Minimum: 1 +Maximum: 128 +Array Length: 0 - 10000 + |
+
operating_system + |
+Yes + |
+String + |
+OSs supported by the policy. The options are as follows: +
|
+
runtime_detection_status + |
+No + |
+String + |
+Whether to perform runtime checks. The options are as follows. Currently, it can only be disabled. This field is reserved. +
|
+
None
+Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.
+PUT https://{endpoint}/v5/{project_id}/ransomware/protection/policy
+
+{
+ "bait_protection_status" : "opened",
+ "exclude_directory" : "",
+ "operating_system" : "Linux",
+ "policy_id" : "0253edfd-30e7-439d-8f3f-17c54c997064",
+ "policy_name" : "aaa",
+ "protection_mode" : "alarm_only",
+ "protection_directory" : "/root",
+ "runtime_detection_status" : "closed",
+ "agent_id_list" : [ "" ]
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+success + |
+
See Error Codes.
+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 Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
+An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.
+Status Code + |
+Status + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request processing succeeded. + |
+
400 + |
+Bad Request + |
+Invalid request parameters. + |
+
500 + |
+Internal Server Error + |
+Internal service error. + |
+
Date + |
+Description + |
+
|---|---|
2024-5-24 + |
+This issue is the seventh official release. +Deleted the API for Querying the Protection List. + |
+
2024-5-17 + |
+This is the sixth official release. +Added the following content: +The default value of the enterprise_project_id is added. +Modified: +
|
+
2024-4-11 + |
+This issue is the fifth official release. +Deleted the region parameter. + |
+
2024-4-3 + |
+This issue is the fourth official release. +Modified the following content: +
|
+
2024-1-10 + |
+This issue is the third official release. +Modified the following content: +
|
+
2023-12-8 + |
+This issue is the second official release. +Modified the following content: +
|
+
2023-9-30 + |
+This issue is the first official release. + |
+
+
+
+
+
+
+
+
+
+
+