文档

GetManagedRule - 获取托管规则详情

更新时间:

获取指定的托管规则详细信息。

接口说明

本文将提供一个示例,查询托管规则cdn-domain-https-enabled的详情。

调试

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

授权信息

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

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

请求参数

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

托管规则标识。

关于如何获取托管规则标识,请参见 ListManagedRules

cdn-domain-https-enabled

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

返回参数

名称类型描述示例值
object

无。

ManagedRuleobject

托管规则详情。

RiskLevelinteger

托管规则的风险等级。取值:

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

托管规则标签列表。

string

托管规则标签。

CDN
OptionalInputParameterDetailsobject

托管规则的可选参数信息。

{}
Identifierstring

托管规则标识。

cdn-domain-https-enabled
CompulsoryInputParameterDetailsobject

托管规则必填参数信息。

{}
SourceDetailsobject []

配置触发方式信息列表。

MessageTypestring

规则触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。
  • ScheduledNotification:周期执行。
ConfigurationItemChangeNotification
MaximumExecutionFrequencystring

规则执行周期。取值:

  • One_Hour:1 小时。
  • Three_Hours:3 小时。
  • Six_Hours:6 小时。
  • Twelve_Hours:12 小时。
  • TwentyFour_Hours:24 小时。
TwentyFour_Hours
Descriptionstring

托管规则描述。

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

托管规则名称。

CDN域名开启HTTPS加密
Scopeobject

托管规则生效范围。

ComplianceResourceTypesarray

托管规则生效的资源类型列表。

string

托管规则生效的资源类型。

ACS::CDN::Domain
HelpUrlsstring

托管规则修正指导的文档链接。

https://example.aliyundoc.com
RequestIdstring

请求 ID。

7E6DDC09-87C1-5310-A924-3491EAAE6F90

示例

正常返回示例

JSON格式

{
  "ManagedRule": {
    "RiskLevel": 1,
    "Labels": [
      "CDN"
    ],
    "OptionalInputParameterDetails": {},
    "Identifier": "cdn-domain-https-enabled",
    "CompulsoryInputParameterDetails": {},
    "SourceDetails": [
      {
        "MessageType": "ConfigurationItemChangeNotification",
        "MaximumExecutionFrequency": "TwentyFour_Hours"
      }
    ],
    "Description": "CDN域名开启HTTPS协议加密,视为“合规”。",
    "ConfigRuleName": "CDN域名开启HTTPS加密",
    "Scope": {
      "ComplianceResourceTypes": [
        "ACS::CDN::Domain"
      ]
    },
    "HelpUrls": "https://example.aliyundoc.com"
  },
  "RequestId": "7E6DDC09-87C1-5310-A924-3491EAAE6F90"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-07-01OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:503
  • 本页导读 (1)
文档反馈