All Products
Search
Document Center

Security Center:DescribeSummaryInfo

Last Updated:Nov 13, 2024

Queries the security information about your assets. The information includes the security score and the numbers of protected and unprotected assets.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeSummaryInfoget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

192.168.XX.XX
LangstringNo

The language of the content within the request and response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

D40198E1-6EA8-482E-B3C7-D9573D75C0CA
Successboolean

Indicates whether the request is successful. Valid values:

  • true: yes
  • false: no
true
AegisClientOfflineCountinteger

The number of unprotected assets.

12
AegisClientOnlineCountinteger

The number of protected assets.

127
SecurityScoreinteger

The security score of the assets. Valid values:

  • 95 to 100: The assets are secure.
  • 85 to 94: The assets are exposed to a few security risks. We recommend that you reinforce your security system in a timely manner.
  • 70 to 84: The assets are exposed to multiple security risks. We recommend that you reinforce your security system in a timely manner.
  • 69 or lower: The current security system is unable to protect the assets against intrusions. We recommend that you reinforce your security system at the earliest opportunity.
44

Examples

Sample success responses

JSONformat

{
  "RequestId": "D40198E1-6EA8-482E-B3C7-D9573D75C0CA",
  "Success": true,
  "AegisClientOfflineCount": 12,
  "AegisClientOnlineCount": 127,
  "SecurityScore": 44
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-30The Error code has changedView Change Details