文档

ListManagedRules - 查询规则模板列表

更新时间:

查询配置审计支持的规则模板列表。

接口说明

背景信息

关于规则的定义、运行原理和规则模板,请参见规则的定义及运行原理

使用说明

本文将提供一个示例,查询关键字为CDN的所有规则模板。返回结果显示共 21 条规则模板。

调试

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

授权信息

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

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

请求参数

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

规则模板关键字。

CDN
PageSizeinteger

分页时每页显示的数据行数。

取值范围:1~100。起始值:1。默认值:10。

10
PageNumberinteger

页码。

起始值:1。默认值:1。

1
RiskLevelinteger

规则模板的风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
1
ResourceTypesstring

规则评估的资源类型。

ACS::ECS::Instance

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

B3E605AB-63D5-1EE0-BFA6-0BAC247B0461
ManagedRulesobject

规则模板。

PageSizeinteger

分页查询时设置的每页行数。取值范围:1~500。

1
PageNumberinteger

规则模板列表的页码。

起始值:1。

10
TotalCountlong

规则模板总数。

21
ManagedRuleListobject []

规则模板详情列表。

RiskLevelinteger

规则风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
1
Descriptionstring

规则模板描述。

CDN域名开启HTTPS协议加密,视为“合规”。
Labelsarray

规则模板分类信息列表。

string

规则模板分类信息。

CDN
Identifierstring

规则模板唯一标识。

cdn-domain-https-enabled
ConfigRuleNamestring

规则模板名称。

CDN域名开启HTTPS加密
HelpUrlsstring

规则模板修正指导的文档链接。

https://example.aliyundoc.com
Scopeobject

规则模板的评估范围。

ComplianceResourceTypesarray

规则模板评估的资源类型范围。

string

规则模板评估的资源类型。

ACS::CDN::Domain
SupportPreviewManagedRuleboolean

规则是否支持预检。取值:

  • true:支持。
  • false:不支持。
true
RemediationTemplateIdentifierstring

支持的修正模板标识。

ACS-CDN-SetDomainServerCertificate
RemediationTemplateNamestring

支持的修正模板名称。

开启CDN域名HTTPS监听

示例

正常返回示例

JSON格式

{
  "RequestId": "B3E605AB-63D5-1EE0-BFA6-0BAC247B0461",
  "ManagedRules": {
    "PageSize": 1,
    "PageNumber": 10,
    "TotalCount": 21,
    "ManagedRuleList": [
      {
        "RiskLevel": 1,
        "Description": "CDN域名开启HTTPS协议加密,视为“合规”。",
        "Labels": [
          "CDN"
        ],
        "Identifier": "cdn-domain-https-enabled",
        "ConfigRuleName": "CDN域名开启HTTPS加密",
        "HelpUrls": "https://example.aliyundoc.com",
        "Scope": {
          "ComplianceResourceTypes": [
            "ACS::CDN::Domain"
          ]
        },
        "SupportPreviewManagedRule": true,
        "RemediationTemplateIdentifier": "ACS-CDN-SetDomainServerCertificate",
        "RemediationTemplateName": "开启CDN域名HTTPS监听"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

变更历史

变更时间变更内容概要操作
2023-04-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:503
出参OpenAPI 返回结构发生变更
2023-03-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:503