DescribeStrategy - Security Center - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	1.2.X.X
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
StrategyIds	string	No	The ID of the baseline check policy that you want to query. Separate multiple IDs with commas (,).	8164248
CustomType	string	No	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

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB
Strategies	array<object>	The details of the baseline check policies.
Strategy	object	The details of the baseline check policy.
Type	integer	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
ExecStatus	integer	The status of the baseline check policy. Valid values: 1: not executed 2: executing	1
PassRate	integer	The proportion of risky baselines in the baseline check result.	0
CycleStartTime	integer	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
CustomType	string	The type of the baseline check policy. Valid values: common custom	custom
EcsCount	integer	The number of the assets to which the baseline check policy is applied.	50
ProcessRate	integer	The number of the assets on which the baseline check is complete.	20
CycleDays	integer	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
RiskCount	integer	The number of baseline check items in the baseline check policy.	23
Name	string	The name of the baseline check policy.	text2
Id	integer	The ID of the baseline check policy.	8164248
ConfigTargets	array<object>	The details of the assets to which the baseline check policy is applied.
ConfigTarget	object	The asset to which the baseline check policy is applied.
Flag	string	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
Target	string	The asset group ID or UUID of the asset to which the baseline check policy is applied.	10099713
TargetType	string	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
StartTime	string	The start time of the baseline check policy.	00:00:00
EndTime	string	The end time of the baseline check policy.	03:00:00
Percent	string	The progress of the baseline check by using the baseline. This parameter is returned only if the value of the ExecStatus parameter is 2.	50%
UserModifyTime	long	The time when the baseline check policy was last modified.	2025-01-07 10:46:43

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",
      "Percent": "50%",
      "UserModifyTime": 0
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ConsoleError	The error message is %s %s.	-
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2024-11-28	The Error code has changed. The response structure of the API has changed	View Change Details