調(diào)用DescribeCompliance接口查詢資源的合規(guī)結(jié)果統(tǒng)計(jì)。

調(diào)試

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

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

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

要執(zhí)行的操作，取值：DescribeCompliance。
ResourceType String 否 ACS::ECS::Instance

資源類型。

當(dāng)您按資源維度查詢資源評(píng)估結(jié)果時(shí)，必須配置參數(shù)ResourceType和ResourceId。
ResourceId String 否 i-bp151g9tpto890zr****

資源ID。

當(dāng)您按資源維度查詢資源評(píng)估結(jié)果時(shí)，必須配置參數(shù)ResourceType和ResourceId。
ComplianceType String 否 COMPLIANT

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

  • COMPLIANT：合規(guī)。
  • NON_COMPLIANT：不合規(guī)。
  • NOT_APPLICABLE：不適用。
  • INSUFFICIENT_DATA：數(shù)據(jù)不充分。
ConfigRuleId String 否 cr-12b398b633820012****

規(guī)則ID。

當(dāng)您按規(guī)則維度查詢資源評(píng)估結(jié)果時(shí)，必須同時(shí)配置參數(shù)ConfigRuleId、ResourceType和ResourceId，否則ConfigRuleId無(wú)效。
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)參見(jiàn)賬號(hào)組。

MemberId Long 否 100931896542****

該參數(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)參見(jiàn)賬號(hào)組。

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

名稱 類型 示例值 描述
ComplianceResult Object

合規(guī)結(jié)果統(tǒng)計(jì)。
TotalCount Long 1

所有合規(guī)類型的數(shù)量統(tǒng)計(jì)。

  • 當(dāng)入?yún)⒅付≧esourceId時(shí)，該參數(shù)為資源數(shù)量統(tǒng)計(jì)值。
  • 當(dāng)入?yún)⒅付–onfigRuleId時(shí)，該參數(shù)為規(guī)則數(shù)量統(tǒng)計(jì)值。
Compliances Array of Compliances

資源合規(guī)結(jié)果統(tǒng)計(jì)。
ComplianceType String COMPLIANT

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

  • COMPLIANT：合規(guī)。
  • NON_COMPLIANT：不合規(guī)。
  • NOT_APPLICABLE：不適用。
  • INSUFFICIENT_DATA：無(wú)數(shù)據(jù)。
Count Integer 1

指定合規(guī)類型的數(shù)量統(tǒng)計(jì)。

  • 當(dāng)入?yún)⒅付≧esourceId時(shí)，該參數(shù)為資源數(shù)統(tǒng)計(jì)值。
  • 當(dāng)入?yún)⒅付–onfigRuleId時(shí)，該參數(shù)為規(guī)則數(shù)統(tǒng)計(jì)值。
RequestId String 17306AB1-34E0-468F-BD7B-68D8AEAB754F

請(qǐng)求ID。

示例

請(qǐng)求示例

http(s)://[Endpoint]/?Action=DescribeCompliance
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式

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

<DescribeComplianceResponse>
    <ComplianceResult>
        <TotalCount>1</TotalCount>
        <Compliances>
            <ComplianceType>COMPLIANT</ComplianceType>
            <Count>1</Count>
        </Compliances>
    </ComplianceResult>
    <RequestId>17306AB1-34E0-468F-BD7B-68D8AEAB754F</RequestId>
</DescribeComplianceResponse>

JSON格式

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

{
  "ComplianceResult" : {
    "TotalCount" : 1,
    "Compliances" : [ {
      "ComplianceType" : "COMPLIANT",
      "Count" : 1
    } ]
  },
  "RequestId" : "17306AB1-34E0-468F-BD7B-68D8AEAB754F"
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
404 AccountNotExisted Your account does not exist. 您的賬號(hào)不存在。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服務(wù)不可用。

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