All Products
Search
Document Center

Security Center:GetCheckSummary

Last Updated:May 06, 2024

Queries the summary information about the configuration checks on cloud services.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:GetCheckSummaryRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

  • zh: Chinese
  • en: English
zh
ResourceDirectoryAccountIdstringNo

The account ID of the resource directory.

000
VendorsarrayNo

The cloud service providers.

stringNo

The cloud service provider. Valid values:

  • ALIYUN: an asset provided by Alibaba Cloud.
  • TENCENT: an asset provided by Tencent Cloud.
  • AWS: an asset provided by Amazon Web Services (AWS).
ALIYUN
IsItemStatisticbooleanNo

Specifies whether to return the statistics of the check items, including the number of check items supported by the system and the number of check items available to you.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Summarysobject []

The summary information about the configuration checks on cloud services.

Typestring

The type of the check item. Valid values:

  • COMPLIANCE
  • RISK
  • IDENTITY_PERMISSION
IDENTITY_PERMISSION
PassCountlong

The number of check items that pass the check.

10
FailCountinteger

The number of detected risk items.

5
Standardsobject []

The information about the check items.

Idlong

The ID of the check item.

1
ShowNamestring

The name of the check item.

Identity and permission management
PassCountinteger

The number of check items that pass the check.

1
FailCountinteger

The number of check items that failed to pass the check.

1
RiskLevelHighCountinteger

The number of high-risk items.

1
RiskLevelMediumCountinteger

The number of medium-risk items.

1
RiskLevelLowCountinteger

The number of low-risk items.

1
StandardStatisticobject

The standard statistics of the check items.

PassCountinteger

The number of check items that pass the check.

3
PassLowCountinteger

The number of low-risk check items that pass the check.

1
PassMediumCountinteger

The number of medium-risk check items that pass the check.

1
PassHighCountinteger

The number of high-risk check items that pass the check.

1
NotPassCountinteger

The number of check items that failed to pass the check.

3
NotPassLowCountinteger

The number of low-risk check items that failed to pass the check.

1
NotPassMediumCountinteger

The number of medium-risk check items that failed to pass the check.

1
NotPassHighCountinteger

The number of high-risk check items that failed to pass the check.

1
NotCheckCountinteger

The number of unchecked check items.

3
NotCheckLowCountinteger

The number of unchecked low-risk check items.

1
NotCheckMediumCountinteger

The number of unchecked medium-risk check items.

1
NotCheckHighCountinteger

The number of unchecked high-risk check items.

1
TypeStatisticobject

The risk statistics by type.

PassCountinteger

The number of check items that pass the check.

3
PassLowCountinteger

The number of low-risk check items that pass the check.

1
PassMediumCountinteger

The number of medium-risk check items that pass the check.

1
PassHighCountinteger

The number of high-risk check items that pass the check.

1
NotPassCountinteger

The number of check items that failed to pass the check.

3
NotPassLowCountinteger

The number of low-risk check items that failed to pass the check.

1
NotPassMediumCountinteger

The number of medium-risk check items that failed to pass the check.

1
NotPassHighCountinteger

The number of high-risk check items that failed to pass the check.

1
NotCheckCountinteger

The number of unchecked check items.

3
NotCheckLowCountinteger

The number of unchecked low-risk check items.

1
NotCheckMediumCountinteger

The number of unchecked medium-risk check items.

1
NotCheckHighCountinteger

The number of unchecked high-risk check items.

1
OverallStatisticobject

The overall risk statistics.

PassCountinteger

The number of check items that pass the check.

3
PassLowCountinteger

The number of low-risk check items that pass the check.

1
PassMediumCountinteger

The number of medium-risk check items that pass the check.

1
PassHighCountinteger

The number of high-risk check items that pass the check.

1
NotPassCountinteger

The number of check items that failed to pass the check.

3
NotPassLowCountinteger

The number of low-risk check items that failed to pass the check.

1
NotPassMediumCountinteger

The number of medium-risk check items that failed to pass the check.

1
NotPassHighCountinteger

The number of high-risk check items that failed to pass the check.

1
NotCheckCountinteger

The number of unchecked check items.

3
NotCheckLowCountinteger

The number of unchecked low-risk check items.

1
NotCheckMediumCountinteger

The number of unchecked medium-risk check items.

1
NotCheckHighCountinteger

The number of unchecked high-risk check items.

1
RequestIdstring

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

843E4805-****-7EE12FA8DBFD
OverallItemStatisticobject

The statistics about the number of check items.

ResultCountinteger

The number of check items available to you.

25
ReleaseCountinteger

The number of check items supported by the system.

620

Examples

Sample success responses

JSONformat

{
  "Summarys": [
    {
      "Type": "IDENTITY_PERMISSION",
      "PassCount": 10,
      "FailCount": 5,
      "Standards": [
        {
          "Id": 1,
          "ShowName": "Identity and permission management\n",
          "PassCount": 1,
          "FailCount": 1,
          "RiskLevelHighCount": 1,
          "RiskLevelMediumCount": 1,
          "RiskLevelLowCount": 1,
          "StandardStatistic": {
            "PassCount": 3,
            "PassLowCount": 1,
            "PassMediumCount": 1,
            "PassHighCount": 1,
            "NotPassCount": 3,
            "NotPassLowCount": 1,
            "NotPassMediumCount": 1,
            "NotPassHighCount": 1,
            "NotCheckCount": 3,
            "NotCheckLowCount": 1,
            "NotCheckMediumCount": 1,
            "NotCheckHighCount": 1
          }
        }
      ],
      "TypeStatistic": {
        "PassCount": 3,
        "PassLowCount": 1,
        "PassMediumCount": 1,
        "PassHighCount": 1,
        "NotPassCount": 3,
        "NotPassLowCount": 1,
        "NotPassMediumCount": 1,
        "NotPassHighCount": 1,
        "NotCheckCount": 3,
        "NotCheckLowCount": 1,
        "NotCheckMediumCount": 1,
        "NotCheckHighCount": 1
      }
    }
  ],
  "OverallStatistic": {
    "PassCount": 3,
    "PassLowCount": 1,
    "PassMediumCount": 1,
    "PassHighCount": 1,
    "NotPassCount": 3,
    "NotPassLowCount": 1,
    "NotPassMediumCount": 1,
    "NotPassHighCount": 1,
    "NotCheckCount": 3,
    "NotCheckLowCount": 1,
    "NotCheckMediumCount": 1,
    "NotCheckHighCount": 1
  },
  "RequestId": "843E4805-****-7EE12FA8DBFD",
  "OverallItemStatistic": {
    "ResultCount": 25,
    "ReleaseCount": 620
  }
}

Error codes

HTTP status codeError codeError messageDescription
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
2024-01-22The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: IsItemStatistic
Output ParametersThe response structure of the API has changed.
2023-12-21The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Vendors
Output ParametersThe response structure of the API has changed.
2023-01-11The API operation is not deprecated.see changesets
Change itemChange content
API Deprecation DescriptionThe API operation is not deprecated..