All Products
Search
Document Center

Security Center:DescribeStrategy

Last Updated:Nov 13, 2024

Queries the details about baseline check policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeStrategyget
  • All Resources
    *
    none
none

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

The data returned.

RequestIdstring

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

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

The details of the baseline check policies.

Strategyobject

The baseline check policy.

Typeinteger

The source type of the baseline check policy. Valid values:

  • 1: indicates a built-in policy provided and performed by Security Center by default.
  • 2: indicates a user-defined policy. It can be a standard or custom baseline check policy.
2
ExecStatusinteger

The status of the baseline check policy. Valid values:

  • 1: not executed
  • 2: executing
1
PassRateinteger

The proportion of risky baselines 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
  • custom
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<object>

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

ConfigTargetobject

The asset to which the baseline check policy is applied.

Flagstring

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

  • add: The baseline check policy is applied to the asset group.
  • del: the baseline check policy is not applied to the asset group.
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
StartTimestring

The start time of the baseline check policy.

00:00:00
EndTimestring

The end time of the baseline check policy.

03:00:00

Examples

Sample success responses

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"
        }
      ],
      "StartTime": "00:00:00",
      "EndTime": "03:00:00"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400ConsoleErrorThe error message is %s %s.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.