All Products
Search
Document Center

Security Center:DescribeStrategy

Last Updated:Nov 30, 2022

Queries the details about baseline check policies.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

1.2.X.X
LangstringNo

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

  • zh: Chinese
  • en: English
zh
StrategyIdsstringNo

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

8164248
CustomTypestringNo

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

  • common: standard baseline check policy
  • custom: custom baseline check policy
custom

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB
Strategiesarray

An array that consists of the baseline check policies.

object
Typeinteger

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.
2
ExecStatusinteger

The status of the baseline check policy. Valid values:

  • 1: disabled
  • 2: enabled
1
PassRateinteger

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

0
CycleStartTimeinteger

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.
0
CustomTypestring

The type of the baseline check policy. Valid values:

  • common: standard baseline check policy
  • custom: custom baseline check policy
custom
EcsCountinteger

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

50
ProcessRateinteger

The number of the assets on which the baseline check is complete.

20
CycleDaysinteger

The cycle of the baseline check. Valid values:

  • 1: every 2 days
  • 3: every 4 days
  • 7: every 8 days
  • 30: every 31 days
1
RiskCountinteger

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

23
Namestring

The name of the baseline check policy.

text2
Idinteger

The ID of the baseline check policy.

8164248
ConfigTargetsarray

An array consisting of the assets to which the baseline check policy is applied.

object
Flagstring

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

  • add: yes
  • del: no
add
Targetstring

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

10099713
TargetTypestring

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
groupId

Example

Normal return example

JSONFormat

{
  "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 codeError codeError message
400ConsoleErrorThe error message is %s %s.
500ServerErrorServerError

For a list of error codes, visit the API error center.