DescribeStrategy API Overview for Baseline Check Policies - Security Center - Alibaba Cloud - Security Center

Queries baseline check policy details.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeStrategy

get

*BaselineStrategy

acs:yundun-sas:{#regionId}:{#accountId}:baselinestrategy/*

None

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 request and response content. Default value: zh. Valid values: zh: Chinese en: English	zh
StrategyIds	string	No	The ID of the baseline check policy. Separate multiple IDs with commas (,).	8164248
CustomType	string	No	The type of the baseline check policy. Valid values: common: standard baseline check policy custom: custom baseline check policy	custom

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB
Strategies	array<object>	The details of the baseline check policies.
	array<object>	The details of the baseline check policy.
Type	integer	The source type of the baseline check policy. Valid values: 1: a built-in policy provided by Security Center by default. 2: a user-defined policy, which 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 check result.	0
CycleStartTime	integer	The time when the baseline check starts. Valid values: 0: 00:00 to 06:00. 6: 06:00 to 12:00. 12: 12:00 to 18:00. 18: 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 assets to which the baseline check policy is applied.	50
ProcessRate	integer	The number of 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.
	object	The asset to which the baseline check policy is applied.
Flag	string	Whether the baseline check policy is applied to the asset group. Valid values: add: the policy is applied to the asset group. del: the 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 type of target to which the baseline check policy is applied. 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 baseline check progress. Returned only when ExecStatus is 2.	50%
UserModifyTime	integer	The time when the baseline check policy was last modified.	2025-01-07 10:46:43
ExecutionType	string	The trigger method for baseline scanning. Valid values: Schedule: periodically triggered by a configured schedule. Manual: manually triggered.	Manual

Examples

Success response

JSON format

{
  "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,
      "ExecutionType": "Manual"
    }
  ]
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.