GetCheckSummary - 云平台配置获取检查总览

获取云平台配置检查总览信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:GetCheckSummaryget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Langstring

请求和接收消息的语言类型。

  • zh:中文
  • en:英文
zh
ResourceDirectoryAccountIdstring

资源目录成员账号主账号 ID。

说明 调用 DescribeMonitorAccounts 接口可以获取该参数。
000
Vendorsarray

云厂商列表。

string

所属云厂商。取值:

  • ALIYUN:阿里云
  • TENCENT:腾讯云
  • AWS:亚马逊云
  • HUAWEICLOUD:华为云
  • MICROSOFT:微软云
ALIYUN
IsItemStatisticboolean

是否返回检查项统计信息,包括:系统已发布检查项数、用户当前已有检查项数。默认 false。取值:

  • true:返回
  • false:不返回
false

返回参数

名称类型描述示例值
object

返回对象

Summarysarray<object>

总览返回值。

Summarysobject

返回值单项

Typestring

检查项类型。包括:

  • COMPLIANCE: 合规
  • RISK:安全风险
  • IDENTITY_PERMISSION: 身份权限
IDENTITY_PERMISSION
PassCountlong

通过检查的检查项个数。

10
FailCountinteger

检查到的风险项数量。

5
Standardsarray<object>

检查项的标准输出。

Standardsobject

检查项的标准输出。

Idlong

检查项 ID。

1
ShowNamestring

检查项名称。

身份权限管理
PassCountinteger

通过检查项数量。

1
FailCountinteger

未通过检查项数量。

1
RiskLevelHighCountinteger

风险等级为高危的检查项数量。

1
RiskLevelMediumCountinteger

风险等级为中危的检查项数量。

1
RiskLevelLowCountinteger

风险等级为低危的检查项数量。

1
StandardStatisticobject

标准的风险统计信息。

PassCountinteger

通过检查项数量。

3
PassLowCountinteger

通过的级别为低危的检查项数量。

1
PassMediumCountinteger

通过的级别为中危的检查项数量。

1
PassHighCountinteger

通过的级别为高危的检查项数量。

1
NotPassCountinteger

未通过检查项数量。

3
NotPassLowCountinteger

未通过的级别为低危的检查项数量。

1
NotPassMediumCountinteger

未通过的级别为中危的检查项数量。

1
NotPassHighCountinteger

未通过的级别为高危的检查项数量。

1
NotCheckCountinteger

未检查的检查项数量。

3
NotCheckLowCountinteger

未检查的级别为低危的检查项数量。

1
NotCheckMediumCountinteger

未检查的级别为中危的检查项数量。

1
NotCheckHighCountinteger

未检查的级别为高危的检查项数量。

1
TypeStatisticobject

风险类别的风险统计信息。

PassCountinteger

通过检查项数量。

3
PassLowCountinteger

通过的级别为低危的检查项数量。

1
PassMediumCountinteger

通过的级别为中危的检查项数量。

1
PassHighCountinteger

通过的级别为高危的检查项数量。

1
NotPassCountinteger

未通过检查项数量。

3
NotPassLowCountinteger

未通过的级别为低危的检查项数量。

1
NotPassMediumCountinteger

未通过的级别为中危的检查项数量。

1
NotPassHighCountinteger

未通过的级别为高危的检查项数量。

1
NotCheckCountinteger

未检查的检查项数量。

3
NotCheckLowCountinteger

未检查的级别为低危的检查项数量。

1
NotCheckMediumCountinteger

未检查的级别为中危的检查项数量。

1
NotCheckHighCountinteger

未检查的级别为高危的检查项数量。

1
OverallStatisticobject

整体风险统计信息。

PassCountinteger

通过检查项数量。

3
PassLowCountinteger

通过的级别为低危的检查项数量。

1
PassMediumCountinteger

通过的级别为中危的检查项数量。

1
PassHighCountinteger

通过的级别为高危的检查项数量。

1
NotPassCountinteger

未通过检查项数量。

3
NotPassLowCountinteger

未通过的级别为低危的检查项数量。

1
NotPassMediumCountinteger

未通过的级别为中危的检查项数量。

1
NotPassHighCountinteger

未通过的级别为高危的检查项数量。

1
NotCheckCountinteger

未检查的检查项数量。

3
NotCheckLowCountinteger

未检查的级别为低危的检查项数量。

1
NotCheckMediumCountinteger

未检查的级别为中危的检查项数量。

1
NotCheckHighCountinteger

未检查的级别为高危的检查项数量。

1
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

843E4805-****-7EE12FA8DBFD
OverallItemStatisticobject

检查项数相关统计信息。

ResultCountinteger

用户当前已有检查项数。

25
ReleaseCountinteger

系统已发布检查项数。

620

示例

正常返回示例

JSON格式

{
  "Summarys": [
    {
      "Type": "IDENTITY_PERMISSION",
      "PassCount": 10,
      "FailCount": 5,
      "Standards": [
        {
          "Id": 1,
          "ShowName": "身份权限管理",
          "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
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-12-21OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-01-11OpenAPI 去除了 deprecated 标记查看变更详情