Querying Configuration Check Policy Groups

Function

This API is used to query the configuration check policy group list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/baseline/security-checks/policy-groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
offset	Yes	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number of configuration checks. Range The value range is 0 to 1,000,000.
data_list	Array of SecurityCheckPolicyGroupInfoResponseInfo objects	Definition Data list.

**Table 5** SecurityCheckPolicyGroupInfoResponseInfo
Parameter	Type	Description
group_id	String	Definition Policy group ID. Range The value can contain 1 to 64 characters.
group_name	String	Definition Policy group name. Range The value can contain 1 to 256 characters.
check_rule_num	Integer	Definition Number of baseline check items (rules). Range Value range: 1 to 10,000
host_num	Integer	Definition Number of application servers. Range The value range is 0 to 1,000,000.
deletable	Boolean	Definition Whether deletion is supported. Range true: supported false: not supported
default_group	Boolean	Definition Whether a policy group is the default policy group Range true: Yes false: No
support_os	String	Definition OS supported by the policy Range Linux Windows
policy_info	SecurityCheckPolicyInfoResponseInfo object	Definition Configure policy information.
weak_pwd_policy_info	SecurityCheckPolicyInfoResponseInfo object	Definition Weak password and password complexity check policy information
agent_id_list	Array of strings	Definition Agent ID list of the application servers. Range An ID can contain 20 to 64 characters.
task_condition	SecurityCheckTaskCondition object	Definition Configure scheduled check
detection_period	String	Definition Check frequency. Range The value is a string of 1 to 128 characters.

**Table 6** SecurityCheckPolicyInfoResponseInfo
Parameter	Type	Description
content	String	Definition Policy details. Range The value range is 0 to 10,241.

**Table 7** SecurityCheckTaskCondition
Parameter	Type	Description
type	String	Definition Scheduled task type. Range fixed_weekday: fixed workday
day_of_week	Array of strings	Weekday when the rule is triggered. The value can be 0 or multiple values.
hour	Integer	Definition The scheduled task is triggered at the hour specified by this parameter. Range Minimum value: 0; maximum value: 23
minute	Integer	Definition The scheduled task is triggered at the minute specified by this parameter. Range Minimum value: 0; maximum value: 59
random_offset	Integer	Definition Random deviation time (seconds). Range Minimum value: 0; maximum value: 7,200

Example Requests

Query the configuration check policy group list

GET https://{endpoint}/v5/{project_id}/baseline/security-checks/policy-groups?limit=10&offset=0&enterprise_project_id=all_granted_ep

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1004,
  "data_list" : [ {
    "deletable" : true,
    "group_id" : "cfc8b66a-4b3b-42fa-bd94-cd6eacbafc42",
    "group_name" : "Copy Windows.",
    "check_rule_num" : 1,
    "host_num" : 0,
    "default_group" : false,
    "support_os" : "Windows",
    "policy_info" : {
      "content" : "xxx"
    }
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management

Previous topic: Copying Configuration Detection Policy Information

Next topic: Querying Statistics of Baseline Checks Including Weak Passwords, Password Complexity, and Configuration Checks

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot