調(diào)用ListConfigRules接口查詢規(guī)則列表。

調(diào)試

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

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

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

要執(zhí)行的操作，取值：ListConfigRules。
ConfigRuleState String 否 ACTIVE

規(guī)則的狀態(tài)。取值：

  • ACTIVE：應(yīng)用中。
  • EVALUATING：評(píng)估中。
  • INACTIVE：已停用。
ComplianceType String 否 COMPLIANT

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

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

規(guī)則的風(fēng)險(xiǎn)等級(jí)。取值：

  • 1：高風(fēng)險(xiǎn)。
  • 2：中風(fēng)險(xiǎn)。
  • 3：低風(fēng)險(xiǎn)。
PageNumber Integer 是 1

規(guī)則列表的頁(yè)碼。起始值：1。
PageSize Integer 是 20

分頁(yè)查詢時(shí)設(shè)置的每頁(yè)行數(shù)。取值范圍：1~100。
MultiAccount Boolean 否 true

該參數(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)組。

ConfigRuleName String 否 OSS合規(guī)管理最佳實(shí)踐-OSS存儲(chǔ)空間ACL禁止公共讀訪問

規(guī)則的名稱。
CompliancePackId String 否 cp-8d5c6457e0d9002a****

規(guī)則所屬的合規(guī)包ID。

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

名稱 類型 示例值 描述
RequestId String 8195B664-9565-4685-89AC-8B5F04B44B92

請(qǐng)求ID。
ConfigRules Object

規(guī)則列表。
ConfigRuleList Array of ConfigRule

規(guī)則列表。
CompliancePackId String cp-8d5c6457e0d9002a****

規(guī)則所屬的合規(guī)包ID。
RiskLevel Integer 1

規(guī)則的風(fēng)險(xiǎn)等級(jí)。取值：

  • 1：高風(fēng)險(xiǎn)。
  • 2：中風(fēng)險(xiǎn)。
  • 3：低風(fēng)險(xiǎn)。
SourceOwner String ALIYUN

規(guī)則來(lái)源的歸屬。取值：

  • CUSTOM_FC：用戶自定義函數(shù)。
  • ALIYUN：托管規(guī)則。
AccountId Long 987654321

該規(guī)則歸屬的阿里云賬號(hào)ID。
ConfigRuleState String ACTIVE

當(dāng)前規(guī)則運(yùn)行狀態(tài)。取值：

  • ACTIVE：應(yīng)用中。
  • EVALUATING：評(píng)估中。
  • INACTIVE：已停用。
Compliance Object

規(guī)則合規(guī)情況統(tǒng)計(jì)。
ComplianceType String COMPLIANT

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

  • COMPLIANT：合規(guī)。
  • NON_COMPLIANT：不合規(guī)。
  • NOT_APPLICABLE：不適用。
  • INSUFFICIENT_DATA：數(shù)據(jù)不充分。
Count Integer 161

該規(guī)則符合指定合規(guī)類型的資源數(shù)統(tǒng)計(jì)。
SourceIdentifier String oss-bucket-public-read-prohibited

規(guī)則標(biāo)識(shí)。

  • 如果規(guī)則使用了托管規(guī)則，則該參數(shù)為托管規(guī)則名稱。
  • 如果規(guī)則使用了自定義函數(shù)，則該參數(shù)為函數(shù)ARN。
ConfigRuleArn String acs:config::120886317861****:rule/cr-8d5c6457e0d9002a****

規(guī)則ARN。
Description String OSS存儲(chǔ)空間的ACL策略禁止公共讀訪問，視為“合規(guī)”。

規(guī)則的描述信息。
CreateBy Object

規(guī)則的創(chuàng)建信息。
CompliancePackId String cp-8d5c6457e0d9002a****

合規(guī)包ID。
CompliancePackName String OSS合規(guī)管理最佳實(shí)踐

合規(guī)包名稱。
AutomationType String LC

修正模板類型。取值：LC。

說(shuō)明 LC：邏輯編排（Logic Composer）。
ConfigRuleName String OSS合規(guī)管理最佳實(shí)踐-OSS存儲(chǔ)空間ACL禁止公共讀訪問

規(guī)則名稱。
ConfigRuleId String cr-8d5c6457e0d9002a****

規(guī)則ID。
Tags Array of tag

標(biāo)簽。
Key String Key1

標(biāo)簽值。
Value String Value1

標(biāo)簽鍵。
PageNumber Integer 1

規(guī)則列表的頁(yè)碼。起始值：1。
PageSize Integer 20

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

規(guī)則總數(shù)。

示例

請(qǐng)求示例

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

正常返回示例

XML格式

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

<ListConfigRulesResponse>
	<RequestId>8195B664-9565-4685-89AC-8B5F04B44B92</RequestId>
	<ConfigRules>
		<TotalCount>1</TotalCount>
		<PageSize>20</PageSize>
		<PageNumber>1</PageNumber>
		<ConfigRuleList>
			<CompliancePackId>cp-8d5c6457e0d9002a****</CompliancePackId>
			<ConfigRuleId>cr-8d5c6457e0d9002a****</ConfigRuleId>
			<AccountId>987654321</AccountId>
			<Description>OSS存儲(chǔ)空間的ACL策略禁止公共讀訪問，視為“合規(guī)”。</Description>
			<Compliance>
				<ComplianceType>COMPLIANT</ComplianceType>
				<Count>161</Count>
			</Compliance>
			<ConfigRuleArn>acs:config::120886317861****:rule/cr-8d5c6457e0d9002a****</ConfigRuleArn>
			<SourceOwner>ALIYUN</SourceOwner>
			<SourceIdentifier>oss-bucket-public-read-prohibited</SourceIdentifier>
			<CreateBy>
				<CompliancePackId>cp-8d5c6457e0d9002a628b</CompliancePackId>
				<CompliancePackName>OSS合規(guī)管理最佳實(shí)踐</CompliancePackName>
				<CreatorId>1208863178612953</CreatorId>
			</CreateBy>
			<ConfigRuleName>OSS合規(guī)管理最佳實(shí)踐-OSS存儲(chǔ)空間ACL禁止公共讀訪問</ConfigRuleName>
			<RiskLevel>1</RiskLevel>
			<ConfigRuleState>ACTIVE</ConfigRuleState>
		</ConfigRuleList>
	</ConfigRules>
</ListConfigRulesResponse>

JSON格式

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

{
  "RequestId" : "8195B664-9565-4685-89AC-8B5F04B44B92",
  "ConfigRules" : {
    "TotalCount" : 1,
    "PageSize" : 20,
    "PageNumber" : 1,
    "ConfigRuleList" : [ {
      "CompliancePackId" : "cp-8d5c6457e0d9002a****",
      "ConfigRuleId" : "cr-8d5c6457e0d9002a****",
      "AccountId" : "987654321",
      "Description" : "OSS存儲(chǔ)空間的ACL策略禁止公共讀訪問，視為“合規(guī)”。",
      "Compliance" : {
        "ComplianceType" : "COMPLIANT",
        "Count" : 161
      },
      "ConfigRuleArn" : "acs:config::120886317861****:rule/cr-8d5c6457e0d9002a****",
      "SourceOwner" : "ALIYUN",
      "SourceIdentifier" : "oss-bucket-public-read-prohibited",
      "CreateBy" : {
        "CompliancePackId" : "cp-8d5c6457e0d9002a628b",
        "CompliancePackName" : "OSS合規(guī)管理最佳實(shí)踐",
        "CreatorId" : "1208863178612953"
      },
      "ConfigRuleName" : "OSS合規(guī)管理最佳實(shí)踐-OSS存儲(chǔ)空間ACL禁止公共讀訪問",
      "RiskLevel" : 1,
      "ConfigRuleState" : "ACTIVE"
    } ]
  }
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
400 NoPermission You are not authorized to perform this operation. 您無(wú)權(quán)執(zhí)行此操作。
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ò)誤碼。