All Products
Search
Document Center

Security Center:DescribeSoarStrategyTaskDetail

Last Updated:Aug 24, 2024

Queries the details of a policy task on the Playbook page, including the execution status of the task and the process information of the task.

Operation description

Only the Enterprise and Ultimate editions of Security Center support this API operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StrategyTaskIdlongYes

The ID of the policy task.

Note You can call the DescribeSoarStrategyTasks operation to obtain the ID.
10585
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

FBBEB173-1F43-505F-A876-C03ECDF6CE4C
TaskDetailobject

The details of the task.

LogInfostring

The operational log information of the task.

{ "resultContent": "{\"failedNum\":0,\"totalNum\":1,\"successNum\":1}", "resultStatus": 0, "status": 2 }
ProcessInfostring

The process information of the task.

{ "edges": [ { "level": 0, "removeFlag": 0, "source": 1, "target": 8 } ], "nodes": [ { "actionId": "Action_014s73k", "iconUrl": "https://img.alicdn.com/tfs/TB1T*****jSZLeXXb9kVXa-12-14.svg", "id": 1, "label": "describeDisks", "nodeName": "DescribeDisks", "status": 0, "type": "openAPI" } ] }
Paramsstring

The parameters of the task.

[ { "name": "vulList", "associationProperty": "sasAllVul", "value": [ { "regionId": "cn-hangzhou", "instanceId": "i-bp10i3dtyq7x4****5e", "instanceName": "xxx", "vulId": 1222, "vulName": "centos:7:cesa-2024:1249", "vulAliasName": "CESA-2024:1249", "vulTag": "oval", "vulUuid": "3c5eb76a-df89-****-85ef-67562cdc2344", "vulType": "cve", "vulModifyTs": 1721324258000 } ] }, { "name": "snapshotConfig", "associationProperty": "snapshotConfig", "value": { "ttl": 1 } }, { "name": "notifyConfig", "associationProperty": "notifyConfig", "value": { "ding": [ { "value": 2195, "label": "test" } ] } } ]
TaskNamestring

The name of the task.

task-1

Examples

Sample success responses

JSONformat

{
  "RequestId": "FBBEB173-1F43-505F-A876-C03ECDF6CE4C",
  "TaskDetail": {
    "LogInfo": "{\n\"resultContent\": \"{\\\"failedNum\\\":0,\\\"totalNum\\\":1,\\\"successNum\\\":1}\",\n\"resultStatus\": 0,\n\"status\": 2\n}",
    "ProcessInfo": "{\n    \"edges\": [\n        {\n            \"level\": 0,\n            \"removeFlag\": 0,\n            \"source\": 1,\n            \"target\": 8\n        }\n    ],\n    \"nodes\": [\n        {\n            \"actionId\": \"Action_014s73k\",\n            \"iconUrl\": \"https://img.alicdn.com/tfs/TB1T*****jSZLeXXb9kVXa-12-14.svg\",\n            \"id\": 1,\n            \"label\": \"describeDisks\",\n            \"nodeName\": \"DescribeDisks\",\n            \"status\": 0,\n            \"type\": \"openAPI\"\n        }\n    ]\n}",
    "Params": "[\n    {\n        \"name\": \"vulList\",\n        \"associationProperty\": \"sasAllVul\",\n        \"value\": [\n            {\n                \"regionId\": \"cn-hangzhou\",\n                \"instanceId\": \"i-bp10i3dtyq7x4****5e\",\n                \"instanceName\": \"xxx\",\n                \"vulId\": 1222,\n                \"vulName\": \"centos:7:cesa-2024:1249\",\n                \"vulAliasName\": \"CESA-2024:1249\",\n                \"vulTag\": \"oval\",\n                \"vulUuid\": \"3c5eb76a-df89-****-85ef-67562cdc2344\",\n                \"vulType\": \"cve\",\n                \"vulModifyTs\": 1721324258000\n            }\n        ]\n    },\n    {\n        \"name\": \"snapshotConfig\",\n        \"associationProperty\": \"snapshotConfig\",\n        \"value\": {\n            \"ttl\": 1\n        }\n    },\n    {\n        \"name\": \"notifyConfig\",\n        \"associationProperty\": \"notifyConfig\",\n        \"value\": {\n            \"ding\": [\n                {\n                    \"value\": 2195,\n                    \"label\": \"test\"\n                }\n            ]\n        }\n    }\n]",
    "TaskName": "task-1"
  }
}

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.