Queries the details about a baseline check policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeStrategy

The operation that you want to perform. Set the value to DescribeStrategy.

SourceIp String No 1.2.X.X

The source IP address of the request.

Lang String No zh

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
StrategyIds String No 8164248

The ID of the baseline check policy that you want to query. Separate multiple IDs with commas (,).

CustomType String No custom

The type of the baseline check policy that you want to query. Valid values:

  • common: standard baseline check policies
  • custom: custom baseline check policies

Response parameters

Parameter Type Example Description
RequestId String 75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB

The ID of the request, which is used to locate and troubleshoot issues.

Strategies Array of Strategy

Details about baseline check policies.

Type Integer 2

The source of the baseline check policy. Valid values:

  • 1: built-in policy, which indicates that the baseline check policy is provided and performed by Security Center by default.
  • 2: user-defined policy, which can be a standard or custom baseline check policy.
ExecStatus Integer 1

The status of the baseline check policy. Valid values:

  • 1: disabled
  • 2: enabled
PassRate Integer 0

The proportion of risk items to all baseline check items in the baseline check result.

CycleStartTime Integer 0

The time when the baseline check starts. Valid values:

  • 0: The baseline check starts within the time range from 00:00 to 06:00.
  • 6: The baseline check starts within the time range from 06:00 to 12:00.
  • 12: The baseline check starts within the time range from 12:00 to 18:00.
  • 18: The baseline check starts within the time range from 18:00 to 24:00.
CustomType String custom

The type of the baseline check policy. Valid values:

  • common: standard baseline check policies
  • custom: custom baseline check policies
EcsCount Integer 50

The number of the assets to which the baseline check policy is applied.

ProcessRate Integer 20

The number of the assets on which baseline checks are complete.

CycleDays Integer 1

The cycle of the baseline check. Valid values:

  • 1: every other day
  • 3: every 3 days
  • 7: every 7 days
  • 30: every 30 days
RiskCount Integer 23

The number of baseline check items in the baseline check policy.

Name String text2

The name of the baseline check policy.

Id Integer 8164248

The ID of the baseline check policy.

ConfigTargets Array of ConfigTarget

The information about the asset to which the baseline check policy is applied.

Flag String add

Indicates whether the baseline check policy is applied to the asset group. Valid values:

  • add: yes
  • del: no
Target String 10099713

The asset group ID or UUID of the asset to which the baseline check policy is applied.

TargetType String groupId

The condition by which the baseline check policy is applied to the asset. Valid values:

  • groupId: the ID of the asset group
  • uuid: the UUID of the asset

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeStrategy
&SourceIp=1.2.X.X
&Lang=zh
&StrategyIds=8164248
&CustomType=custom
&Common request parameters

Sample success responses

XML format

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 format

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"
    } ]
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 ConsoleError The error message is %s %s. The error message is %s %s.
500 ServerError ServerError The error message returned because an internal error occurred.

For a list of error codes, visit the API Error Center.