QueryGuidTaskList API Overview - Security Center - Alibaba Cloud - Security Center

Security Center provides rewards such as value-added service authorization quotas and log analysis storage capacity to users who complete tasks. Queries the completion status and reward information of configuration tasks.

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:QueryGuidTaskList

list

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	7532B7EE-7CE7-5F4D-BF04-B12447D****
GuideTaskConfigList	array<object>	The list of beginner task information.
	array<object>	The beginner task information.
Status	integer	The task status. Valid values: 0: Closed. 1: In progress. 2: Completed.	0
TaskTypeName	string	The node name. Valid values: guid_task_security_score_promote_video: the node of watching the beginner quick start video guide_sub_task_config_defence_hbr: the anti-ransomware configuration node for servers guide_sub_task_config_uni_defence_hbr: the anti-ransomware configuration node for databases guid_task_log_analysis_config: the log analysis node guide_sub_task_web_lock_config: the web tamper-proofing node guide_sub_task_config_anti_crack: the anti-brute-force attacks node guid_task_container_security_video: the container security video node guid_task_container_image_scan_config: the container image scan node guid_task_k8s_log_analysis_config: the Kubernetes threat detection node guid_task_container_network: the container visualization node guide_sub_task_config_add_collection: the node of adding the console to favorites guide_sub_task_vul_scan: the vulnerability scanning node guide_sub_task_virusKill: the virus scan node.	guide_sub_task_config_add_collection
TaskId	integer	The task ID.	t-000d8slfgx4p40kb64ad
RewardData	object	The reward information for task completion.
Reward	string	The name of the reward. Valid values: addTrialDay: the days of trial use. addAntiRansomwareCapacity: the anti-ransomware capacity. addImageScanAuthCount: the quota for container image scan. addWebLockAuthCount: the quota for web tamper proofing. addSlsCapacity: the log storage capacity.	addAntiRansomwareCapacity
RewardConfig	string	The reward configuration. The value of this parameter is in the JSON format. Note The key indicates the reward type, and the value indicates the number of rewards. Valid values of key: webLockAuthCount: the quota for web tamper proofing. webLockAuthCount: the anti-ransomware capacity. Unit: GB. slsCapacity: the log storage capacity. Unit: GB. days: the days of trial use. imageScanAuthCount: the quota for container image scan. honeypotAuthCount: the quota for cloud honeypot.	{"days":60,"ransomwareCapacity":10}
IsRewardTaked	string	Indicates whether the reward is claimed. Valid values: 1: no. 2: yes.	1
SecurityScore	integer	The security score increase that can be gained by completing this task.	80

Examples

Success response

JSON format

{
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447D****",
  "GuideTaskConfigList": [
    {
      "Status": 0,
      "TaskTypeName": "guide_sub_task_config_add_collection",
      "TaskId": 0,
      "RewardData": {
        "Reward": "addAntiRansomwareCapacity",
        "RewardConfig": "{\"days\":60,\"ransomwareCapacity\":10}",
        "IsRewardTaked": "1"
      },
      "SecurityScore": 80
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.