文档

DescribeStrategy - 查询基线检查策略

更新时间:

查询基线检查策略。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeStrategyget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SourceIpstring

访问源 IP 地址。

1.2.X.X
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
zh
StrategyIdsstring

要查询的策略的 ID。多个 ID 之间使用半角逗号(,)隔开。

8164248
CustomTypestring

要查询的策略的类型。取值:

  • common:标准策略
  • custom:自定义策略
custom

返回参数

名称类型描述示例值
object

基线检查策略返回信息。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB
Strategiesarray<object>

策略的详细信息集合。

Strategyobject

策略的详细信息。

Typeinteger

策略的来源类型。取值:

  • 1:系统自带的策略,即云安全中心默认执行的基线检查策略。
  • 2:用户添加的策略,包括用户自定义创建的标准策略和自定义策略。
2
ExecStatusinteger

基线检查策略的执行状态。取值:

  • 1:未执行
  • 2:执行中
1
PassRateinteger

执行基线检查策略发现的存在风险的基线的占比。

0
CycleStartTimeinteger

基线检查开始的时间。取值:

  • 0:表示基线检查开始的时间为 0:00~6:00
  • 6:表示基线检查开始的时间为 6:00~12:00
  • 12:表示基线检查开始的时间为 12:00~18:00
  • 18:表示基线检查开始的时间为 18:00~24:00
0
CustomTypestring

策略的类型。取值:

  • common:标准策略
  • custom:自定义策略
custom
EcsCountinteger

策略生效的资产的数量。

50
ProcessRateinteger

已完成基线检查的资产的数量。

20
CycleDaysinteger

基线检查的周期。取值:

  • 1:每隔 1 天
  • 3:每隔 3 天
  • 7:每隔 7 天
  • 30:每隔 30 天
1
RiskCountinteger

策略包含的基线检查项的数量。

23
Namestring

策略的名称。

text2
Idinteger

策略的 ID。

8164248
ConfigTargetsarray<object>

策略生效资产的信息集合。

ConfigTargetobject

策略生效资产的信息。

Flagstring

策略是否对该资产分组生效。取值:

  • add:对该资产分组生效
  • del:不对该资产分组生效
add
Targetstring

策略生效的资产的分组 ID 或者 UUID。

10099713
TargetTypestring

策略生效资产的添加方式。取值:

  • groupId:按照资产的分组添加。
  • uuid:按照单个资产添加。
groupId
StartTimestring

基线检查策略执行开始时间。

00:00:00
EndTimestring

基线检查策略执行结束时间。

03:00:00

示例

正常返回示例

JSON格式

{
  "RequestId": "75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB",
  "Strategies": [
    {
      "Type": 2,
      "ExecStatus": 1,
      "PassRate": 0,
      "CycleStartTime": 0,
      "CustomType": "custom",
      "EcsCount": 50,
      "ProcessRate": 20,
      "CycleDays": 1,
      "RiskCount": 23,
      "Name": "text2",
      "Id": 8164248,
      "ConfigTargets": [
        {
          "Flag": "add",
          "Target": "10099713",
          "TargetType": "groupId"
        }
      ],
      "StartTime": "00:00:00",
      "EndTime": "03:00:00"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ConsoleErrorThe error message is %s %s.错误信息为%s %s。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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