文档

ListCheckItem - 获取可以进行自定义检查项配置模版列表

更新时间:

获取可以进行自定义检查项配置列表。

调试

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

授权信息

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

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

请求参数

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

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
PageSizeinteger

分页查询时,每页显示的数据的最大条数。默认值为 20

10
Langstring

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

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

ListCheckResultResponse

CheckItemsobject []

检查项信息列表。

InstanceSubTypestring

云产品的资产子类型。取值:

  • InstanceType 取值为 ECS 时,本参数的取值:
    • INSTANCE
    • DISK
    • SECURITY_GROUP
  • InstanceType 取值为 ACR 时,本参数的取值:
    • REPOSITORY_ENTERPRISE
    • REPOSITORY_PERSON
  • InstanceType 取值为 RAM 时,本参数的取值:
    • ALIAS
    • USER
    • POLICY
    • GROUP
  • InstanceType 取值为 WAF 时,本参数的取值:
    • DOMAIN
  • InstanceType 取值为其他时,本参数的取值:
    • INSTANCE
ECS
CheckIdlong

检查项 id。

21
CheckShowNamestring

检查项名称。

IPv4访问控制
InstanceTypestring

云产品的资产类型。取值:

  • ECS:云服务器
  • SLB:负载均衡
  • RDS:RDS 数据库
  • MONGODB:MongoDb 数据库
  • KVSTORE:Redis 数据库
  • ACR:ACR
  • CSK:CSK
  • VPC:VPC
  • ACTIONTRAIL:操作审计
  • CDN:CDN
  • CAS:数字证书管理服务[原 SSL 证书]
  • RDC:云效
  • RAM:RAM
  • DDOS:分布式拒绝服务
  • WAF:WAF
  • OSS:访问控制
  • POLARDB:POLARDB
  • POSTGRESQL:PostgreSQL
  • MSE:MSE
  • NAS:NAS
  • SDDP:SDDP
  • EIP:EIP
OSS
RiskLevelstring

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

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

云资产厂商。取值:

  • 0:阿里云资产
  • 1:云外资产
  • 2:IDC 资产
  • 3457:其它云资产
  • 8:轻量应用服务器
0
SectionIdsarray

检查项关联章节列表。

long

检查项关联章节 ID。

102
Descriptionobject

检查项描述。

Typestring

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

  • text:文本
text
Valuestring

检查项风险的描述类型为 text 时的文本内容。

API网关(API Gateway)访问控制不应直接对公网所有地址开放,应设定严格的访问控制策略,白名单规则中不包含0.0.0.0。也可以自定义配置IP值${IPList}。
CustomConfigsobject []

用户自定义检查配置信息列表。

Namestring

用户自定义检查配置名称。

IPList
TypeDefinestring

检查项自定义配置项类型 JSON 字符串。

{\"type\":\"LIST\",\"range\":[1,512],\"listType\":{\"type\":\"STRING\",\"range\":[0,22]}}
DefaultValuestring

检查项自定义配置项默认值字符串。

0
Valuestring

检查项自定义配置项用户配置字符串。

1
ShowNamestring

用户自定义检查配置展示名称。

IP列表
PageInfoobject

分页查询时的页面信息。

CurrentPageinteger

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

1
PageSizeinteger

分页大小。

10
TotalCountinteger

查询结果的总数。

149
Countinteger

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

10
RequestIdstring

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

9F4E6157-9600-5588-86B9-38F09067****

示例

正常返回示例

JSON格式

{
  "CheckItems": [
    {
      "InstanceSubType": "ECS",
      "CheckId": 21,
      "CheckShowName": "IPv4访问控制",
      "InstanceType": "\bOSS",
      "RiskLevel": "HIGH",
      "Vendor": "0",
      "SectionIds": [
        102
      ],
      "Description": {
        "Type": "text",
        "Value": "API网关(API Gateway)访问控制不应直接对公网所有地址开放,应设定严格的访问控制策略,白名单规则中不包含0.0.0.0。也可以自定义配置IP值${IPList}。"
      },
      "CustomConfigs": [
        {
          "Name": "IPList",
          "TypeDefine": "{\\\"type\\\":\\\"LIST\\\",\\\"range\\\":[1,512],\\\"listType\\\":{\\\"type\\\":\\\"STRING\\\",\\\"range\\\":[0,22]}}",
          "DefaultValue": "0",
          "Value": "1",
          "ShowName": "IP列表"
        }
      ]
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 149,
    "Count": 10
  },
  "RequestId": "9F4E6157-9600-5588-86B9-38F09067****"
}

错误码

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

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

  • 本页导读 (1)
文档反馈