調用DescribeConfigRule接口查詢規則詳情。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeConfigRule

要執行的操作，取值：DescribeConfigRule。

ConfigRuleId String 是 cr-7bc06457e0d90041****

規則ID。關于如何查詢規則ID，請參見ListConfigRules。

MultiAccount Boolean 否 false

該參數計劃于2021年06月30日00時00分00秒前下線，其替代功能賬號組的API將于2021年05月30日00時00分00秒前上線。如果您正在使用該參數，建議您在2021年05月30日00時00分00秒之后切換為賬號組的API。關于賬號組，請參見賬號組。

MemberId Long 否 123456789

該參數計劃于2021年06月30日00時00分00秒前下線，其替代功能賬號組的API將于2021年05月30日00時00分00秒前上線。如果您正在使用該參數，建議您在2021年05月30日00時00分00秒之后切換為賬號組的API。關于賬號組，請參見賬號組。

返回數據

名稱 類型 示例值 描述
RequestId String A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99

請求ID。
ConfigRule Object

規則詳情。
RiskLevel Integer 3

規則的風險等級。取值：

  • 1：高風險。
  • 2：中風險。
  • 3：低風險。
InputParameters Map

規則入參。
Source Object

規則執行邏輯的來源信息。
SourceDetails Array of SourceDetails

規則來源詳情。
MessageType String ConfigurationItemChangeNotification

規則的觸發機制。取值：

  • ConfigurationItemChangeNotification：配置變更。
  • ScheduledNotification：周期執行。
EventSource String aliyun.config

事件來源。

說明 目前僅支持配置審計事件：aliyun.config。
MaximumExecutionFrequency String Six_Hours

規則的執行周期。取值：

  • One_Hour：1小時。
  • Three_Hours：3小時。
  • Six_Hours：6小時。
  • Twelve_Hours：12小時。
  • TwentyFour_Hours：24小時。
Owner String ALIYUN

規則來源的歸屬。取值：

  • CUSTOM_FC：用戶自定義函數。
  • ALIYUN：托管規則。
SourceConditions Array of SourceConditions

規則的配置條件。
DesiredValue String 2

規則入參的期望值。
Tips String 實例的狀態

參數的提示信息。
Operator String GreaterOrEquals

規則入參的操作符。通過SelectPath獲取到的不同數據類型，對應不同的操作符。

  • 當數據類型為String時，取值：
    • StringEquals：等于。
    • NotStringEquals：不等于。
    • StringIn：存在。
    • NotStringIn：不存在。
    • StringContains：包含。
    • NotStringContains：不包含。
  • 當數據類型為Number時，取值：
    • Equals：等于。
    • NotEquals：不等于。
    • Less：小于。
    • LessOrEquals：小于等于。
    • Greater：大于。
    • GreaterOrEquals：大于等于。
  • 當數據類型為基于Base64進制編碼的Base64 String時，取值：
    • Base64Contains：包含。
    • NotBase64Contains：不包含。
    • Base64ContainsAll：包含全部。
    • Base64ExcludeAll：排除全部。
  • 當數據類型為Array時，取值：
    • Contains：包含。
    • NotContains：不包含。
    • In：存在。
    • NotIn：不存在。
    • ContainsAll：包含全部。
    • ExcludeAll：排除全部。
    • IsEmpty：為空。
Name String cpuCount

規則入參的名稱。
Identifier String rds-cpu-min-count-limit

規則標識。

  • 如果規則使用了托管規則，則該參數為托管規則名稱。
  • 如果規則使用了自定義函數，則該參數為函數ARN。
ConfigRuleState String ACTIVE

當前規則的運行狀態。取值：

  • ACTIVE：應用中。
  • EVALUATING：評估中。
  • INACTIVE：已停用。
MaximumExecutionFrequency String Six_Hours

規則的執行周期。取值：

  • One_Hour：1小時。
  • Three_Hours：3小時。
  • Six_Hours：6小時。
  • Twelve_Hours：12小時。
  • TwentyFour_Hours：24小時。
ManagedRule Object

托管規則詳情。
SourceDetails Array of SourceDetails

托管規則詳情。
MessageType String ConfigurationItemChangeNotification

規則的觸發機制。取值：

  • ConfigurationItemChangeNotification：配置變更。
  • ScheduledNotification：周期執行。
EventSource String aliyun.config

規則的事件來源。

說明 目前僅支持配置審計事件：aliyun.config。
MaximumExecutionFrequency String Six_Hours

規則的執行周期。取值：

  • One_Hour：1小時。
  • Three_Hours：3小時。
  • Six_Hours：6小時。
  • Twelve_Hours：12小時。
  • TwentyFour_Hours：24小時。
Description String RDS實例的CPU核數大于等于設置的閾值，視為“合規”。

托管規則的描述信息。
Labels Array of String ["RDS","CPU"]

托管規則的標簽列表。
Identifier String rds-cpu-min-count-limit

托管規則的標識符。
OptionalInputParameterDetails Map

托管規則可選參數的描述信息。
ManagedRuleName String rds-cpu-min-count-limit

托管規則的名稱。
CompulsoryInputParameterDetails Map

托管規則必填參數的信息。
ConfigRuleArn String acs:config::120886317861****:rule/cr-7bc06457e0d90041****

規則ARN。
Description String RDS實例的CPU核數大于等于設置的閾值，視為“合規”。

規則的描述信息。
ConfigRuleName String RDS實例CPU核數滿足最低要求

規則名稱。
Scope Object

規則的監控范圍。
ComplianceResourceTypes Array of String ["ACS::RDS::DBInstance"]

待評估資源類型列表。
ComplianceResourceId String vpc-6weoy5flv41pj4wvr****

待評估資源ID。
ConfigRuleEvaluationStatus Object

資源評估狀態。
LastErrorCode String FunctionNotFound

規則最近一次執行的錯誤碼。
LastSuccessfulEvaluationTimestamp Long 1618901957876

規則最近一次調用成功的結束時間戳。
FirstActivatedTimestamp Long 1618901952341

首次激活時間戳。
FirstEvaluationStarted Boolean true

規則是否已執行過評估。取值：

  • true（默認值）
  • false
LastSuccessfulInvocationTimestamp Long 1618901957395

規則最近一次調用成功的開始時間戳。
LastErrorMessage String function 'funtionName' does not exist in service 'serviceName'

規則最近一次執行的錯誤信息。
LastFailedEvaluationTimestamp Long 1602819143913

規則最近一次調用失敗的結束時間戳。
LastFailedInvocationTimestamp Long 1602819143910

規則最近一次調用失敗的開始時間戳。
ConfigRuleId String cr-7bc06457e0d90041****

規則ID。
ModifiedTimestamp Long 1602992721000

規則最近一次修改的時間戳。
CreateTimestamp Long 1602818964884

創建規則時的時間戳。

示例

請求示例

http(s)://[Endpoint]/?Action=DescribeConfigRule
&ConfigRuleId=cr-7bc06457e0d90041****
&<公共請求參數>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeConfigRuleResponse>
	<RequestId>A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99</RequestId>
	<ConfigRule>
		<ManagedRule>
			<ManagedRuleName>rds-cpu-min-count-limit</ManagedRuleName>
			<OptionalInputParameterDetails />
			<Description>RDS實例的CPU核數大于等于設置的閾值，視為“合規”。</Description>
			<Identifier>rds-cpu-min-count-limit</Identifier>
			<CompulsoryInputParameterDetails>
				<cpuCount>
					<defaultValue>2</defaultValue>
					<type>integer</type>
				</cpuCount>
			</CompulsoryInputParameterDetails>
			<Labels>RDS</Labels>
			<Labels>CPU</Labels>
			<SourceDetails>
				<EventSource>aliyun.config</EventSource>
				<MessageType>ConfigurationItemChangeNotification</MessageType>
			</SourceDetails>
		</ManagedRule>
		<ConfigRuleEvaluationStatus>
			<FirstActivatedTimestamp>1618901952341</FirstActivatedTimestamp>
			<LastSuccessfulEvaluationTimestamp>1618901957876</LastSuccessfulEvaluationTimestamp>
			<FirstEvaluationStarted>true</FirstEvaluationStarted>
			<LastSuccessfulInvocationTimestamp>1618901957395</LastSuccessfulInvocationTimestamp>
		</ConfigRuleEvaluationStatus>
		<ConfigRuleState>ACTIVE</ConfigRuleState>
		<Source>
			<Owner>ALIYUN</Owner>
			<Identifier>rds-cpu-min-count-limit</Identifier>
			<SourceConditions>
				<Operator>GreaterOrEquals</Operator>
				<DesiredValue>2</DesiredValue>
				<Required>true</Required>
				<SelectPath>$.DBInstanceCPU</SelectPath>
			</SourceConditions>
			<SourceDetails>
				<EventSource>aliyun.config</EventSource>
				<MessageType>ConfigurationItemChangeNotification</MessageType>
			</SourceDetails>
		</Source>
		<OrganizationRule>false</OrganizationRule>
		<ConfigRuleId>cr-7bc06457e0d90041****</ConfigRuleId>
		<Scope>
			<ComplianceResourceTypes>ACS::RDS::DBInstance</ComplianceResourceTypes>
		</Scope>
		<ConfigRuleArn>acs:config::120886317861****:rule/cr-7bc06457e0d90041****</ConfigRuleArn>
		<ConfigRuleName>RDS實例CPU核數滿足最低要求</ConfigRuleName>
		<RiskLevel>3</RiskLevel>
		<InputParameters>
			<cpuCount>2</cpuCount>
		</InputParameters>
	</ConfigRule>
</DescribeConfigRuleResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99",
  "ConfigRule" : {
    "ManagedRule" : {
      "ManagedRuleName" : "rds-cpu-min-count-limit",
      "OptionalInputParameterDetails" : { },
      "Description" : "RDS實例的CPU核數大于等于設置的閾值，視為“合規”。",
      "Identifier" : "rds-cpu-min-count-limit",
      "CompulsoryInputParameterDetails" : {
        "cpuCount" : {
          "defaultValue" : "2",
          "type" : "integer"
        }
      },
      "Labels" : [ "RDS", "CPU" ],
      "SourceDetails" : [ {
        "EventSource" : "aliyun.config",
        "MessageType" : "ConfigurationItemChangeNotification"
      } ]
    },
    "ConfigRuleEvaluationStatus" : {
      "FirstActivatedTimestamp" : 1618901952341,
      "LastSuccessfulEvaluationTimestamp" : 1618901957876,
      "FirstEvaluationStarted" : true,
      "LastSuccessfulInvocationTimestamp" : 1618901957395
    },
    "ConfigRuleState" : "ACTIVE",
    "Source" : {
      "Owner" : "ALIYUN",
      "Identifier" : "rds-cpu-min-count-limit",
      "SourceConditions" : [ {
        "Operator" : "GreaterOrEquals",
        "DesiredValue" : "2",
        "Required" : true,
        "SelectPath" : "$.DBInstanceCPU"
      } ],
      "SourceDetails" : [ {
        "EventSource" : "aliyun.config",
        "MessageType" : "ConfigurationItemChangeNotification"
      } ]
    },
    "OrganizationRule" : false,
    "ConfigRuleId" : "cr-7bc06457e0d90041****",
    "Scope" : {
      "ComplianceResourceTypes" : [ "ACS::RDS::DBInstance" ]
    },
    "ConfigRuleArn" : "acs:config::120886317861****:rule/cr-7bc06457e0d90041****",
    "ConfigRuleName" : "RDS實例CPU核數滿足最低要求",
    "RiskLevel" : 3,
    "InputParameters" : {
      "cpuCount" : "2"
    }
  }
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
400 ConfigRuleNotExists The ConfigRule does not exist. 此規則不存在。
400 NoPermission You are not authorized to perform this operation. 您無權執行此操作。
404 AccountNotExisted Your account does not exist. 您的賬號不存在。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服務不可用。

訪問錯誤中心查看更多錯誤碼。