GetInspectProgress - 获取任务执行进度

更新时间:
复制 MD 格式

获取任务执行进度(普通用户、RD单账号)

接口说明

不兼容 Go SDK,如需要 Go SDK 请使用 DescribeAdvicesFlatPage API。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

advisor:GetInspectProgress

none

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

TaskId

integer

否

所要查询的任务 ID。

95***135

AssumeAliyunId

integer

否

巡检主账号

14********37

Token

string

否

集成 ARMS Prometheus 监控所需的 Token。

***

返回参数

名称

类型

描述

示例值

object

RequestId

string

Id of the request

566331F9-****-550F-B745-A730331F97A9

Success

boolean

请求是否成功。

True

Code

string

错误编码。

200

Message

string

返回结果的提示信息。

Successful

Data

object

查询结果。

AllSubtaskCount

integer

所有子任务数量

100

Finish

boolean

任务是否结束:

  • true:任务结束。

  • false:任务未结束。

True

FinishRate

number

任务完成率。

1

FinishSubtaskCount

integer

完成子任务计数

1

LastInspectDate

integer

上次检查日期

111

TaskId

integer

后台生成的任务 ID。

95***135

UsedTime

integer

耗时。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "566331F9-****-550F-B745-A730331F97A9\n",
  "Success": true,
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "AllSubtaskCount": 100,
    "Finish": true,
    "FinishRate": 1,
    "FinishSubtaskCount": 1,
    "LastInspectDate": 111,
    "TaskId": 0,
    "UsedTime": 1
  }
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError The request processing has failed due to some unknown error. 服务端错误。
403 Forbidden.NotActivated User has not activated Advisor Service. 用户未开通Advisor产品。
403 Forbidden.NotAuthorized User has not authorized Advisor to provide services.
403 Forbidden.RAM User not authorized to operate on the specified resource, or this API doesn't support RAM. 未通过鉴权
403 Rd.NoManagePermission The RD management account does not have the specified member account management permission. RD管理账号没有指定成员账号管理权限
403 Rd.NoMasterRole Login account is not RD management or co-management role. 登录账号不是RD管理或协管角色

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

变更历史

更多信息,参考变更详情。