調(diào)用DescribeEvaluationResults接口查詢資源評(píng)估結(jié)果。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

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

要執(zhí)行的操作,取值:DescribeEvaluationResults

ResourceType String ACS::ECS::Instance

資源類型。當(dāng)您按資源類型查詢資源評(píng)估結(jié)果時(shí),必須配置該參數(shù)。

您可以通過GetSupportedResourceTypes接口獲取配置審計(jì)支持的資源類型列表。更多信息,請(qǐng)參見GetSupportedResourceTypes

說明 資源類型(ResourceType)和規(guī)則ID(ConfigRuleId)二選一。
ResourceId String i-bp151g9tpto890zr****

資源ID。當(dāng)您按資源類型查詢資源評(píng)估結(jié)果時(shí),必須配置該參數(shù)。

ComplianceType String COMPLIANT

合規(guī)類型。取值:

  • COMPLIANT:合規(guī)。
  • NON_COMPLIANT:不合規(guī)。
  • NOT_APPLICABLE:不適用。
  • INSUFFICIENT_DATA:數(shù)據(jù)不充分。
PageNumber Integer 1

資源評(píng)估結(jié)果列表的頁碼。起始值:1。

PageSize Integer 10

分頁查詢時(shí)設(shè)置的每頁行數(shù)。取值范圍:1~100。

ConfigRuleId String cr-2da35180a8d1008e****

規(guī)則ID。當(dāng)您按規(guī)則查詢資源評(píng)估結(jié)果時(shí),必須配置該參數(shù)。

說明 資源類型(ResourceType)和規(guī)則ID(ConfigRuleId)二選一。
MultiAccount Boolean false

該參數(shù)計(jì)劃于2021年06月30日00時(shí)00分00秒前下線,其替代功能賬號(hào)組的API將于2021年05月30日00時(shí)00分00秒前上線。如果您正在使用該參數(shù),建議您在2021年05月30日00時(shí)00分00秒之后切換為賬號(hào)組的API。關(guān)于賬號(hào)組,請(qǐng)參見賬號(hào)組

MemberId Long 123456789

該參數(shù)計(jì)劃于2021年06月30日00時(shí)00分00秒前下線,其替代功能賬號(hào)組的API將于2021年05月30日00時(shí)00分00秒前上線。如果您正在使用該參數(shù),建議您在2021年05月30日00時(shí)00分00秒之后切換為賬號(hào)組的API。關(guān)于賬號(hào)組,請(qǐng)參見賬號(hào)組

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
RequestId String D296EE41-1143-4B13-83BB-909008100130

請(qǐng)求ID。

EvaluationResults Object

資源評(píng)估結(jié)果。

EvaluationResultList Array of EvaluationResult

資源評(píng)估結(jié)果列表。

RiskLevel Integer 1

風(fēng)險(xiǎn)等級(jí)。取值:

  • 1:高風(fēng)險(xiǎn)。
  • 2:中風(fēng)險(xiǎn)。
  • 3:低風(fēng)險(xiǎn)。
ComplianceType String COMPLIANT

合規(guī)類型。取值:

  • COMPLIANT:合規(guī)。
  • NON_COMPLIANT:不合規(guī)。
  • NOT_APPLICABLE:不適用。
  • INSUFFICIENT_DATA:數(shù)據(jù)不充分。
ResultRecordedTimestamp Long 1589941923432

資源評(píng)估結(jié)果的時(shí)間戳。

Annotation String {"operator": "StringEquals", "property": "$.SslProtocol", "desiredValue": "on", "configuration": "['off']"}

不合規(guī)資源的補(bǔ)充信息。

ConfigRuleInvokedTimestamp Long 1589941923258

調(diào)用規(guī)則評(píng)估資源時(shí)的時(shí)間戳。

InvokingEventMessageType String ConfigurationItemChangeNotification

規(guī)則的觸發(fā)機(jī)制。取值:

  • ConfigurationItemChangeNotification:配置變更。
  • ScheduledNotification:周期執(zhí)行。
EvaluationResultIdentifier Object

資源評(píng)估結(jié)果標(biāo)識(shí)符。

OrderingTimestamp Long 1589941923117

時(shí)間軸展示的時(shí)間戳。

EvaluationResultQualifier Object

規(guī)則評(píng)估的資源范圍。

ConfigRuleArn String acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****

規(guī)則ARN。

ResourceType String ACS::ECS::Instance

規(guī)則評(píng)估的資源類型。

ConfigRuleName String ECS實(shí)例開啟釋放保護(hù)

規(guī)則名稱。

ResourceId String i-bp151g9tpto890zr****

規(guī)則評(píng)估的資源ID。

ConfigRuleId String cr-2da35180a8d1008e****

規(guī)則ID。

ResourceName String launch-advisor-20200330

規(guī)則評(píng)估的資源名稱。

RegionId String cn-hangzhou

地域ID。

RemediationEnabled Boolean false

修正設(shè)置是否啟用。取值:

  • true
  • false
PageNumber Integer 1

資源評(píng)估結(jié)果列表的頁碼。起始值:1。

PageSize Integer 10

分頁查詢時(shí)設(shè)置的每頁行數(shù)。取值范圍:1~100。

TotalCount Long 2

資源評(píng)估結(jié)果的總記錄數(shù)。

示例

請(qǐng)求示例

http(s)://[Endpoint]/?Action=DescribeEvaluationResults
&ConfigRuleId=cr-2da35180a8d1008e****
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式

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

<DescribeEvaluationResultsResponse>
	<RequestId>D296EE41-1143-4B13-83BB-909008100130</RequestId>
	<EvaluationResults>
		<EvaluationResultList>
			<ConfigRuleInvokedTimestamp>1608262263084</ConfigRuleInvokedTimestamp>
			<ComplianceType>COMPLIANT</ComplianceType>
			<ResultRecordedTimestamp>1608262263321</ResultRecordedTimestamp>
			<InvokingEventMessageType>ConfigurationItemChangeNotification</InvokingEventMessageType>
			<EvaluationResultIdentifier>
				<EvaluationResultQualifier>
					<ConfigRuleId>cr-22726457e0d90078****</ConfigRuleId>
					<ConfigRuleArn>acs:config::120886317861****:config-rule/cr-22726457e0d90078****</ConfigRuleArn>
					<ResourceId>i-t4n0piq1mkfo1d27****</ResourceId>
					<ConfigRuleName>ECS實(shí)例開啟釋放保護(hù)</ConfigRuleName>
					<ResourceType>ACS::ECS::Instance</ResourceType>
					<RegionId>cn-hangzhou</RegionId>
				</EvaluationResultQualifier>
				<OrderingTimestamp>1608262263084</OrderingTimestamp>
			</EvaluationResultIdentifier>
			<RiskLevel>3</RiskLevel>
			<RemediationEnabled>true</RemediationEnabled>
			<Annotation></Annotation>
		</EvaluationResultList>
		<EvaluationResultList>
			<ConfigRuleInvokedTimestamp>1608262263084</ConfigRuleInvokedTimestamp>
			<ComplianceType>COMPLIANT</ComplianceType>
			<ResultRecordedTimestamp>1608262263326</ResultRecordedTimestamp>
			<InvokingEventMessageType>ConfigurationItemChangeNotification</InvokingEventMessageType>
			<EvaluationResultIdentifier>
				<EvaluationResultQualifier>
					<ConfigRuleId>cr-22726457e0d90078****</ConfigRuleId>
					<ConfigRuleArn>acs:config::120886317861****:config-rule/cr-22726457e0d90078****</ConfigRuleArn>
					<ResourceId>i-2ze5o2beycwbvqnx****</ResourceId>
					<ConfigRuleName>ECS實(shí)例開啟釋放保護(hù)</ConfigRuleName>
					<ResourceType>ACS::ECS::Instance</ResourceType>
					<RegionId>cn-hangzhou</RegionId>
				</EvaluationResultQualifier>
				<OrderingTimestamp>1608262263084</OrderingTimestamp>
			</EvaluationResultIdentifier>
			<RiskLevel>3</RiskLevel>
			<RemediationEnabled>false</RemediationEnabled>
			<Annotation></Annotation>
		</EvaluationResultList>
		<TotalCount>52</TotalCount>
		<PageSize>10</PageSize>
		<PageNumber>1</PageNumber>
	</EvaluationResults>
</DescribeEvaluationResultsResponse>

JSON格式

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

{
  "RequestId" : "D296EE41-1143-4B13-83BB-909008100130",
  "EvaluationResults" : {
    "EvaluationResultList" : [ {
      "ConfigRuleInvokedTimestamp" : 1608262263084,
      "ComplianceType" : "COMPLIANT",
      "ResultRecordedTimestamp" : 1608262263321,
      "InvokingEventMessageType" : "ConfigurationItemChangeNotification",
      "EvaluationResultIdentifier" : {
        "EvaluationResultQualifier" : {
          "ConfigRuleId" : "cr-22726457e0d90078****",
          "ConfigRuleArn" : "acs:config::120886317861****:config-rule/cr-22726457e0d90078****",
          "ResourceId" : "i-t4n0piq1mkfo1d27****",
          "ConfigRuleName" : "ECS實(shí)例開啟釋放保護(hù)",
          "ResourceType" : "ACS::ECS::Instance",
          "RegionId" : "cn-hangzhou"
        },
        "OrderingTimestamp" : 1608262263084
      },
      "RiskLevel" : 3,
      "RemediationEnabled" : true,
      "Annotation" : ""
    }, {
      "ConfigRuleInvokedTimestamp" : 1608262263084,
      "ComplianceType" : "COMPLIANT",
      "ResultRecordedTimestamp" : 1608262263326,
      "InvokingEventMessageType" : "ConfigurationItemChangeNotification",
      "EvaluationResultIdentifier" : {
        "EvaluationResultQualifier" : {
          "ConfigRuleId" : "cr-22726457e0d90078****",
          "ConfigRuleArn" : "acs:config::120886317861****:config-rule/cr-22726457e0d90078****",
          "ResourceId" : "i-2ze5o2beycwbvqnx****",
          "ConfigRuleName" : "ECS實(shí)例開啟釋放保護(hù)",
          "ResourceType" : "ACS::ECS::Instance",
          "RegionId" : "cn-hangzhou"
        },
        "OrderingTimestamp" : 1608262263084
      },
      "RiskLevel" : 3,
      "RemediationEnabled" : false,
      "Annotation" : ""
    } ],
    "TotalCount" : 52,
    "PageSize" : 10,
    "PageNumber" : 1
  }
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
400 NoPermission You are not authorized to perform this operation. 您無權(quán)執(zhí)行此操作。
404 CloudConfigServiceRoleNotExisted The CloudConfigServiceRole does not exist. 配置審計(jì)的服務(wù)角色不存在。
404 AccountNotExisted Your account does not exist. 您的賬號(hào)不存在。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服務(wù)不可用。

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。