All Products
Search
Document Center

Security Center:QueryGuidTaskList

Last Updated:Nov 25, 2024

Queries the list of beginner tasks. Security Center provides rewards for users who complete tasks. The rewards include the quota for a value-added feature and log storage capacity.

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:QueryGuidTaskListlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

7532B7EE-7CE7-5F4D-BF04-B12447D****
GuideTaskConfigListarray<object>

The list of beginner tasks.

GuideTaskConfigobject

The information about the beginner task.

Statusinteger

The status of the beginner task. Valid values:

  • 0: disabled.
  • 1: in progress.
  • 2: complete.
0
TaskTypeNamestring

The name of the task type. Valid values:

  • guid_task_security_score_promote_video: the task of viewing a video tutorial for beginners.
  • guide_sub_task_config_defence_hbr: the task of configuring anti-ransomware for servers.
  • guide_sub_task_config_uni_defence_hbr: the task of configuring anti-ransomware for databases.
  • guid_task_log_analysis_config: the task of configuring log analysis.
  • guide_sub_task_web_lock_config: the task of configuring web tamper proofing.
  • guide_sub_task_config_anti_crack: the task of configuring protection against brute-force attacks.
  • guid_task_container_security_video: the task of viewing the video on how to protect containers.
  • guid_task_container_image_scan_config: the task of configuring container image scan.
  • guid_task_k8s_log_analysis_config: the task of configuring threat detection on Kubernetes containers.
  • guid_task_container_network: the task of configuring container network visualization.
  • guide_sub_task_config_add_collection: the task of saving a console URL.
  • guide_sub_task_vul_scan: the task of scanning for vulnerabilities.
  • guide_sub_task_virusKill: the task of configuring virus detection and removal.
guide_sub_task_config_add_collection
TaskIdinteger

The ID of the beginner task.

t-000d8slfgx4p40kb64ad
RewardDataobject

The information about the reward for a complete task.

Rewardstring

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.
addWebLockAuthCount
RewardConfigstring

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":100}
IsRewardTakedstring

Indicates whether the reward is claimed. Valid values:

  • 1: no.
  • 2: yes.
1
SecurityScoreinteger

The security score that is increased after you complete the task.

80

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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