ListCheckRule - 查询云安全态势管理的检查规则

查询云安全态势管理的检查项规则。

调试

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

授权信息

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

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

请求参数

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

检查项的 ID。

说明 您可调用 ListCheckResult 接口获取检查项 ID。
58
CheckNamestring

检查项名称。

checkName
RuleTypestring

规则类型。默认 WHITE。取值:

  • WHITE:加白名单
WHITE
ScopeTypestring

规则的生效范围,取值:

  • INSTNACE :实例
  • ITEM:检查项
INSTANCE
CurrentPageinteger

分页查询时,显示的当前页的页码。

1
PageSizeinteger

分页查询时,每页显示的检查项信息的数量。默认值为 20,表示每页显示 20 条检查项信息。

20
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
zh
TaskSourcesarray

任务来源列表。

string

任务来源。取值:

  • YAO_CHI:瑶池控制台。
YAO_CHI

返回参数

名称类型描述示例值
object

返回的数据类型。

RequestIdstring

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

52870893-48A7-5A9E-9E05-6253E5B6****
CheckRulesarray<object>

检查规则。

checkRulesobject
AliUidlong

当前用户的 UID。

176316827610****
Vendorinteger

服务器厂商。取值:

  • 0:阿里云资产
  • 1:云外资产
  • 2:IDC 资产
  • 3457:其它云资产
0
AssetTypeinteger

云资产的类型。

说明 具体含义参考接口 GetCloudAssetCriteria AssetType。
1
CheckIdlong

检查项的 ID。

77
ScopeTypestring

规则的生效范围,取值:

  • INSTNACE :实例
  • ITEM:检查项
INSTANCE
RuleTypestring

规则类型。默认 WHITE。取值:

  • WHITE: 加白名单
WHITE
RuleIdlong

规则 ID。

8000**
CheckShowNamestring

检查项名称。

Check for IPS Whitelist on CEN (Enterprise Edition) Tab
CheckPoliciesarray<object>

检查项的章节展示名称。

checkPoliciesobject

检查项的章节展示名称。

sectionShowNamestring

检查项的章节展示名称。

Access Control
AssetSubTypeinteger

云产品的子类型。

说明 具体含义参考接口 GetCloudAssetCriteria AssetSubType。
0
VendorNamestring

服务器的服务商名称。

ALIYUN
InstanceTypestring

云产品的资产类型。

ecs
InstanceSubTypestring

云产品的资产子类型。

INSTANCE
Remarkstring

备注。

remark
PageInfoobject

分页信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,显示的每页数据的最大条数。

20
Countinteger

当前页显示的数据条数。

10
TotalCountinteger

数据的总条数。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "52870893-48A7-5A9E-9E05-6253E5B6****",
  "CheckRules": [
    {
      "AliUid": 0,
      "Vendor": 0,
      "AssetType": 1,
      "CheckId": 77,
      "ScopeType": "INSTANCE",
      "RuleType": "WHITE",
      "RuleId": 0,
      "CheckShowName": "Check for IPS Whitelist on CEN (Enterprise Edition) Tab",
      "CheckPolicies": [
        {
          "sectionShowName": "Access Control"
        }
      ],
      "AssetSubType": 0,
      "VendorName": "ALIYUN",
      "InstanceType": "ecs",
      "InstanceSubType": "INSTANCE",
      "Remark": "remark"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "Count": 10,
    "TotalCount": 10
  }
}

错误码

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

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