调用DescribeStrategy接口查询基线检查策略。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeStrategy

要执行的操作。取值:DescribeStrategy

SourceIp String 1.2.X.X

访问源IP地址。

Lang String zh

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

  • zh:中文
  • en:英文
StrategyIds String 8164248

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

CustomType String custom

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

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

返回数据

名称 类型 示例值 描述
RequestId String 75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB

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

Strategies Array of Strategy

策略的详细信息。

Type Integer 2

策略的来源类型。取值:

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

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

  • 1:未执行
  • 2:执行中
PassRate Integer 0

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

CycleStartTime Integer 0

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

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

策略的类型。取值:

  • common:标准策略
  • custom:自定义策略
EcsCount Integer 50

策略生效的资产的数量。

ProcessRate Integer 20

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

CycleDays Integer 1

基线检查的周期。取值:

  • 1:每隔1天
  • 3:每隔3天
  • 7:每隔7天
  • 30:每隔30天
RiskCount Integer 23

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

Name String text2

策略的名称。

Id Integer 8164248

策略的ID。

ConfigTargets Array of ConfigTarget

策略生效资产的信息。

Flag String add

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

  • add:对该资产分组生效
  • del:不对该资产分组生效
Target String 10099713

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

TargetType String groupId

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeStrategy
&SourceIp=1.2.X.X
&Lang=zh
&StrategyIds=8164248
&CustomType=custom
&公共请求参数

正常返回示例

XML格式

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

<DescribeStrategyResponse>
    <RequestId>75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB</RequestId>
    <Strategies>
        <Type>2</Type>
        <ExecStatus>1</ExecStatus>
        <PassRate>0</PassRate>
        <CycleStartTime>0</CycleStartTime>
        <CustomType>custom</CustomType>
        <EcsCount>50</EcsCount>
        <ProcessRate>20</ProcessRate>
        <CycleDays>1</CycleDays>
        <RiskCount>23</RiskCount>
        <Name>text2</Name>
        <Id>8164248</Id>
        <ConfigTargets>
            <Flag>add</Flag>
            <Target>10099713</Target>
            <TargetType>groupId</TargetType>
        </ConfigTargets>
    </Strategies>
</DescribeStrategyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
    } ]
  } ]
}

错误码

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