GetSafetyCover - Managed Security Service - Alibaba Cloud Documentation Center

Retrieves the security protection coverage.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-mss:GetSafetyCover

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DateType	string	Yes	The time filter type. Supports filtering by last 7 days, last 30 days, last half year, or custom time range.	month
StartDate	integer	Yes	The start time.	1732255620000
EndDate	integer	Yes	The end time.	1732268720000
SuspEventSource	string	No	The alert event source.	该接口不用传

Response elements

Element	Type	Description	Example
	object	The response.
Data	object	The query result.
WafProtection	object	The WAF protection coverage.
ProtectionCount	integer	Number of protected items.	5
NoProtectionCount	integer	Number of unprotected items.	5
TotalCount	integer	Total number of items.	10
ProtectionRate	string	Protection rate.	50.00
ProtectionGrowthRate	string	Year-over-year growth in protection rate.	35.00
EcsProtection	object	The ECS protection coverage.
ProtectionCount	integer	Number of protected items.	5
NoProtectionCount	integer	Number of unprotected items.	5
TotalCount	integer	Total number of items.	10
ProtectionRate	string	Protection rate.	50.00
ProtectionGrowthRate	string	Year-over-year growth in protection rate.	35.00
CfwProtection	object	The Cloud Firewall (CFW) protection coverage.
ProtectionCount	integer	Number of protected items.	5
NoProtectionCount	integer	Number of unprotected items.	5
TotalCount	integer	Total quantity.	10
ProtectionRate	string	Protection rate.	50.00
ProtectionGrowthRate	string	Year-over-year protection rate.	35.00
RequestId	string	The request ID.	564f8bb9-df3c-42a0-877a-b35d48f66603
Code	string	The response code.	404
Message	string	The message returned for the result.	system error
HttpStatusCode	integer	The HTTP status code.	200
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	True

Examples

Success response

JSON format

{
  "Data": {
    "WafProtection": {
      "ProtectionCount": 5,
      "NoProtectionCount": 5,
      "TotalCount": 10,
      "ProtectionRate": "50.00",
      "ProtectionGrowthRate": "35.00"
    },
    "EcsProtection": {
      "ProtectionCount": 5,
      "NoProtectionCount": 5,
      "TotalCount": 10,
      "ProtectionRate": "50.00",
      "ProtectionGrowthRate": "35.00"
    },
    "CfwProtection": {
      "ProtectionCount": 5,
      "NoProtectionCount": 5,
      "TotalCount": 10,
      "ProtectionRate": "50.00",
      "ProtectionGrowthRate": "35.00"
    }
  },
  "RequestId": "564f8bb9-df3c-42a0-877a-b35d48f66603",
  "Code": "404",
  "Message": "system error",
  "HttpStatusCode": 200,
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.