GetSecuritySuggestionList - 获取安全优化建议列表

更新时间:
复制 MD 格式

获取安全优化建议列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ListConfigRulesRequest

object

否

请求参数。

CompliancePackId

string

否

合规包 ID。

cp-d7b061dbe91500aa179a

ComplianceType

string

否

合规评估结果。取值:

  • COMPLIANT:合规。

  • NON_COMPLIANT:不合规。

  • NOT_APPLICABLE:不适用。

  • INSUFFICIENT_DATA:无数据。

  • IGNORED:已忽略。

COMPLIANT

ConfigRuleName

string

否

规则名称。

The name of the rule.

ConfigRuleState

string

否

规则运行状态。

  • ACTIVE:应用中。

  • DELETING:删除中。

  • EVALUATING:评估中。

  • INACTIVE:已停用。

ACTIVE

Keyword

string

否

查询关键字。

支持对规则 ID、规则名称、规则描述和规则模板标识等进行模糊查询。

ecs

PageNumber

integer

否

页码。

说明

起始值:1。默认值:1。

3

PageSize

integer

否

分页时每页显示的数据行数。

说明

取值范围:1~100。起始值:1。默认值:10。

10

RiskLevel

integer

否

规则风险等级。取值:

  • 1:高风险。

  • 2:中风险。

  • 3:低风险。

1

ResourceTypes

string

否

规则评估的资源类型。

ACS::ECS::Instance

返回参数

名称

类型

描述

示例值

object

返回参数。

RequestId

string

请求 ID。

855FCC89-0B13-5FC0-AAD2-120878081C1C

Code

string

状态码。

  • 200 :成功

  • 其他(400、500):失败

200

Success

boolean

是否调用成功。

  • true:调用成功

  • false:调用失败

true

Message

string

消息。

successful

Data

object

查询结果。

ConfigRuleList

array<object>

规则列表。

array<object>

规则列表详细信息。

AccountId

integer

规则归属的账号 ID。

1625772519123804

AutomationType

string

修正类型。仅支持 OOS(运维编排)。

OOS

Compliance

string

规则的合规聚合结果。

{count=1, complianceType=NON_COMPLIANT}

ConfigRuleArn

string

规则 ARN。

acs:config::100931896542****:rule/cr-fdc8626622af00f9****

ConfigRuleId

string

规则 ID。

cr-bqa2f25bc5ce00af6323

ConfigRuleName

string

规则名称。

The name of the rule.

ConfigRuleState

string

规则运行状态。

  • ACTIVE:应用中。

  • DELETING:删除中。

  • EVALUATING:评估中。

  • INACTIVE:已停用。

ACTIVE

CreateBy

object

创建规则的信息。

CompliancePackId

string

规则所属的合规包 ID。

cp-fdc8626622af00f9****

CompliancePackName

string

合规包名称。

The name of the compliance package.

Description

string

规则描述。

The description of the rule.

ResourceTypesScope

string

资源类型范围,多个资源类型用半角逗号(,)分隔。

ACS::EIP::EipAddress

RiskLevel

integer

规则风险等级。取值:

  • 1:高风险。

  • 2:中风险。

  • 3:低风险。

1

SourceIdentifier

string

规则标识。

  • 如果规则使用了托管规则,则该参数为托管规则名称。

  • 如果规则使用了自定义函数,则该参数为函数 ARN。

eip-bandwidth-limit

SourceOwner

string

规则来源的归属。取值:

  • CUSTOM_FC:自定义规则。

  • ALIYUN:规则模板。

ALIYUN

Tags

array<object>

规则的标签。

object

规则的标签。

Key

string

规则的标签键。

env

Value

string

规则的标签值。

prod

ComplianceObject

object

规则的合规聚合结果。

ComplianceType

string

规则合规评估结果。取值:

  • COMPLIANT:合规。

  • NON_COMPLIANT:不合规。

  • NOT_APPLICABLE:不适用。

  • INSUFFICIENT_DATA:无数据。

NON_COMPLIANT

Count

integer

规则评估的摘要结果对应的评估数量。

2

PageNumber

integer

页码

1

PageSize

integer

每页数

20

TotalCount

integer

规则总数。

51

示例

正常返回示例

JSON格式

{
  "RequestId": "855FCC89-0B13-5FC0-AAD2-120878081C1C",
  "Code": "200",
  "Success": true,
  "Message": "successful",
  "Data": {
    "ConfigRuleList": [
      {
        "AccountId": 1625772519123804,
        "AutomationType": "OOS",
        "Compliance": "{count=1, complianceType=NON_COMPLIANT}",
        "ConfigRuleArn": "acs:config::100931896542****:rule/cr-fdc8626622af00f9****",
        "ConfigRuleId": "cr-bqa2f25bc5ce00af6323",
        "ConfigRuleName": "The name of the rule.",
        "ConfigRuleState": "ACTIVE",
        "CreateBy": {
          "CompliancePackId": "cp-fdc8626622af00f9****",
          "CompliancePackName": "The name of the compliance package."
        },
        "Description": "The description of the rule.",
        "ResourceTypesScope": "ACS::EIP::EipAddress",
        "RiskLevel": 1,
        "SourceIdentifier": "eip-bandwidth-limit",
        "SourceOwner": "ALIYUN",
        "Tags": [
          {
            "Key": "env",
            "Value": "prod"
          }
        ],
        "ComplianceObject": {
          "ComplianceType": "NON_COMPLIANT",
          "Count": 2
        }
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 51
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter Specified parameter is not valid.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。