DescribeSoarStrategyTasks - 查询任务中心策略任务列表

查询任务中心策略任务列表。

接口说明

仅云安全中心的企业版和旗舰版支持该 API 调用,其他版本不支持。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeSoarStrategyTasksget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageNumberinteger

页面编号。

1
PageSizeinteger

分页查询时,显示的每页数据的最大条数。

20

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

24A20733-10A0-4AF6-BE6B-E3322413BB68
PageSizeinteger

分页查询时,显示的每页数据的最大条数。

20
PageNumberinteger

页面编号。

1
TotalCountinteger

总数。

100
SoarStrategyTasksarray<object>

策略任务集合。

SoarStrategyTaskobject

策略任务详情。

Statusstring

任务运行状态。取值:

  • -1:waiting
  • 0:starting
  • 1:running
  • 2:finished
  • 3:schedule
  • 4:pause
0
FailedNuminteger

执行失败数量。

20
StrategyIdlong

策略 ID。

8000
GmtCreatelong

创建策略任务时的时间戳,单位为毫秒。

1708481235000
SuccessNuminteger

执行成功数量。

20
TotalNuminteger

执行任务总数。

20
RunModestring

执行模式。取值:

  • runmode_TRIGGER_BY_USER:手动执行
runmode_TRIGGER_BY_USER
Namestring

策略任务名称。

strategy_name01
GmtModifiedlong

修改创建策略任务时的时间戳,单位为毫秒。

1669869436000
Idlong

策略任务 ID。

5374
GmtFinishlong

执行策略任务完成后的时间戳,单位为毫秒。

1586739841000

示例

正常返回示例

JSON格式

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 100,
  "SoarStrategyTasks": [
    {
      "Status": "0",
      "FailedNum": 20,
      "StrategyId": 8000,
      "GmtCreate": 1708481235000,
      "SuccessNum": 20,
      "TotalNum": 20,
      "RunMode": "runmode_TRIGGER_BY_USER",
      "Name": "strategy_name01",
      "GmtModified": 1669869436000,
      "Id": 5374,
      "GmtFinish": 1586739841000
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。