ListCheckItems - 查询自定义检查项

更新时间:
复制为 MD 格式

查询云安全态势管理自定义检查项列表。

调试

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

授权信息

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

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

请求参数

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

检查项的 ID。

100000000001
CheckShowNamestring

自定义检查项名称。

testCheckItemName
CheckTypesarray

态势感知检查项的来源类型。

string

检查项的类型(标识策略是系统检查项还是用户检查项):

  • CUSTOM:用户自定义
  • SYSTEM:系统预定义
SYSTEM
Langstring

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

  • zh:中文
  • en:英文
zh
Statusesarray

检查项状态。

string

检查项状态。取值:

  • EDIT:编辑中
  • RELEASE:已发布
RELEASE
PageSizeinteger

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
CurrentPageinteger

指定分页查询时,显示的当前页的页码。起始值为 1,默认值为 1

1

返回参数

名称类型描述示例值
object

接口返回的数据体。

RequestIdstring

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

7BC55C8F-226E-5AF5-9A2C-2EC43864****
CheckItemsarray<object>

检查项信息。

CheckItemsobject

检查项信息。

CheckIdlong

检查项 ID。

100000000001
CheckShowNamestring

检查项名称。

testCheckItemName
Vendorstring

云资产厂商。

ALIYUN
InstanceTypestring

云产品的资产类型。

ECS
InstanceSubTypestring

云产品的资产子类型。

DISK
RiskLevelstring

检查项的风险等级。取值:

  • HIGH:高危
  • MEDIUM:中危
  • LOW:低危
HIGH
Statusstring

检查项状态。取值:

  • EDIT:编辑中
  • RELEASE:已发布
EDIT
CheckPoliciesarray<object>

检查结果关联的标准、条例、章节信息列表。

checkPolicyobject

检查结果关联的标准、条例、章节信息。

StandardIdlong

检查项的标准 ID。

10000000001
StandardShowNamestring

检查项的标准展示名称。

testStandardShowName
RequirementIdlong

检查项的条例 ID。

10000000001
RequirementShowNamestring

检查项的条例展示名称。

testRequirementShowName
SectionIdlong

检查项的章节 ID。

10000000001
SectionShowNamestring

检查项的章节展示名称。

testSectionShowName
Typestring

关联的策略大类的名称:

  • AISPM:AI 配置管理(AI-SPM)
  • KISPM:Kubernetes 配置管理(KSPM)
  • IDENTITY_PERMISSION:身份权限管理(CIEM)
  • RISK:安全风险
  • COMPLIANCE:合规风险
AISPM
Descriptionobject

检查项的描述信息。

Typestring

检查描述属性类型。取值:

  • text:文本
text
Valuestring

描述的具体内容信息。

custom description.
Solutionobject

检查项解决方案信息。

Typestring

检查项解决方案信息类型。取值:

  • text:文本
text
Valuestring

检查项风险的解决方案内容。

test solution.
AssistInfoobject

检查项帮助信息。

Typestring

检查项风险的帮助信息类型。取值:

  • text:文本
text
Valuestring

检查项风险的帮助信息的内容。

test assistInfo.
CheckRulestring

自定义检查项定义规则。

{"AssociatedData":{"ToDataList":[{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","FromPropertyPath":"InstanceId"}]},"MatchProperty":{"Operator":"AND","MatchProperties":[{"DataName":"ACS_ECS_Disk","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testId"},{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testInstanceId"}]}}
CheckTypestring

态势感知检查项的来源类型:

  • CUSTOM:用户自定义
  • SYSTEM:态势感知平台预定义
SYSTEM
Remarkstring

备注信息。

remark.
PageInfoobject

分页查询时的页面信息。

TotalCountinteger

查询到的数据总条数。

100
Countinteger

分页查询时,当前页显示数据条数。

20
CurrentPageinteger

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

1
PageSizeinteger

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

20

示例

正常返回示例

JSON格式

{
  "RequestId": "7BC55C8F-226E-5AF5-9A2C-2EC43864****",
  "CheckItems": [
    {
      "CheckId": 100000000001,
      "CheckShowName": "testCheckItemName",
      "Vendor": "ALIYUN",
      "InstanceType": "ECS",
      "InstanceSubType": "DISK",
      "RiskLevel": "HIGH",
      "Status": "EDIT",
      "CheckPolicies": [
        {
          "StandardId": 10000000001,
          "StandardShowName": "testStandardShowName",
          "RequirementId": 10000000001,
          "RequirementShowName": "testRequirementShowName",
          "SectionId": 10000000001,
          "SectionShowName": "testSectionShowName",
          "Type": "AISPM"
        }
      ],
      "Description": {
        "Type": "text",
        "Value": "custom description."
      },
      "Solution": {
        "Type": "text",
        "Value": "test solution."
      },
      "AssistInfo": {
        "Type": "text",
        "Value": "test assistInfo."
      },
      "CheckRule": {
        "AssociatedData": {
          "ToDataList": [
            {
              "DataName": "ACS_ECS_Instance",
              "PropertyPath": "InstanceId",
              "FromPropertyPath": "InstanceId"
            }
          ]
        },
        "MatchProperty": {
          "Operator": "AND",
          "MatchProperties": [
            {
              "DataName": "ACS_ECS_Disk",
              "PropertyPath": "InstanceId",
              "MatchOperator": "EQ",
              "MatchPropertyValue": "testId"
            },
            {
              "DataName": "ACS_ECS_Instance",
              "PropertyPath": "InstanceId",
              "MatchOperator": "EQ",
              "MatchPropertyValue": "testInstanceId"
            }
          ]
        }
      },
      "CheckType": "SYSTEM",
      "Remark": "remark."
    }
  ],
  "PageInfo": {
    "TotalCount": 100,
    "Count": 20,
    "CurrentPage": 1,
    "PageSize": 20
  }
}

错误码

HTTP status code错误码错误信息描述
400ParamIllegal.%sThe parameter %s is invalid, please fill it in again.参数非法,请重新填写

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

变更历史

变更时间变更内容概要操作
2025-11-13新增 OpenAPI查看变更详情