查詢規則列表中的所有規則。
接口說明
本文將提供一個示例,查詢當前賬號內的規則列表。返回結果顯示,規則列表中規則總數為 1 條,評估資源數為 3 條,評估結果為 COMPLIANT(合規)。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
config:ListConfigRules | list | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceTypes | string | 否 | 規則評估的資源類型。 | ACS::ECS::Instance |
PageSize | integer | 否 | 分頁時每頁顯示的數據行數。 取值范圍:1~100。起始值:1。默認值:10。 | 10 |
CompliancePackId | string | 否 | 合規包 ID。 | cp-fe416457e0d90022**** |
ComplianceType | string | 否 | 規則合規評估結果。取值:
| COMPLIANT |
PageNumber | integer | 否 | 頁碼。 起始值:1。默認值:1。 | 1 |
Keyword | string | 否 | 查詢關鍵字。 支持對規則 ID、規則名稱、規則描述和規則模板標識等進行模糊查詢。 | ecs |
ConfigRuleState | string | 否 | 規則運行狀態。取值:
| ACTIVE |
ConfigRuleName | string | 否 | 規則名稱。 | 彈性IP實例帶寬滿足最低要求 |
RiskLevel | integer | 否 | 規則風險等級。取值:
| 1 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "AC3A7E12-72E6-5CC9-A5C1-D8D8919829A7",
"ConfigRules": {
"ConfigRuleList": [
{
"RiskLevel": 1,
"SourceOwner": "ALIYUN",
"AccountId": 0,
"ConfigRuleState": "ACTIVE",
"Compliance": {
"ComplianceType": "COMPLIANT",
"Count": 2
},
"SourceIdentifier": "eip-bandwidth-limit",
"ConfigRuleArn": "acs:config::100931896542****:rule/cr-fdc8626622af00f9****",
"Description": "彈性IP實例可用帶寬大于等于指定參數值,視為“合規”。默認值:10 MB。",
"CreateBy": {
"CompliancePackId": "cp-fdc8626622af00f9****",
"CompliancePackName": "等保三級預檢合規包"
},
"AutomationType": "OOS",
"ConfigRuleName": "彈性IP實例帶寬滿足最低要求",
"ConfigRuleId": "cr-fdc8626622af00f9****",
"Tags": [
{
"Key": "env",
"Value": "prod"
}
],
"ResourceTypesScope": "ACS::EIP::EipAddress"
}
],
"PageSize": 10,
"PageNumber": 1,
"TotalCount": 1
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | NoPermission | You are not authorized to perform this operation. | 您無權執行此操作。 |
400 | Invalid.AggregatorId.Value | The specified AggregatorId is invalid. | 賬號組ID不存在或無權限使用該賬號組。 |
404 | AccountNotExisted | Your account does not exist. | - |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服務不可用。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-06-04 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |