ListNisInspectionTasks - 查询巡检任务列表

网络巡检任务列表。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

nis:ListNisInspectionTasks

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InspectionTaskId

string

巡检任务 ID

ni-8svm******hzr7fh79

InspectionName

string

巡检任务名称

nis巡检

InspectionProject

string

巡检任务采用的巡检方案类别:基础(basic)/自定义场景(customized)

basic

Status

string

任务运行状态:

Creating: 创建中

Active: 已开启

Running: 执行中

Inactive:已关闭

Active

NextToken

string

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

hKrS+MVXkuOgztXnvdml1/R9jhHkiH8eW3CfaOYU0CEL7yiT0zae6J8v1zYNg+d1

MaxResults

integer

分页大小,取值范围:1~100,默认值:20。

20

返回参数

名称

类型

描述

示例值

object

RpcResponse

RequestId

string

请求 ID。

A7F0D6EC-E19E-58AC-AC9F-08036763960F

InspectionTaskList

array<object>

巡检任务列表

object

InspectionTaskId

string

巡检任务 ID

ni-8svm******hzr7fh79

InspectionName

string

巡检任务名称

nis巡检

Status

string

任务运行状态:

Creating: 创建中

Active: 已开启

Running: 执行中

Inactive:已关闭

Active

InspectionProject

string

巡检任务采用的巡检方案类别:基础(basic)/自定义场景(customized)

basic

CreateTime

string

创建时间

2024-06-18 00:14:46

LastUpdateReportId

string

最新报告 ID

nir-b4c4c9******8a25e

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:如果 NextToken 为空表示没有下一次查询。 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj

MaxResults

integer

分页大小,取值范围:1~100,默认值:20。

20

TotalCount

integer

返回的条目总数。

5

示例

正常返回示例

JSON格式

{
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
  "InspectionTaskList": [
    {
      "InspectionTaskId": "ni-8svm******hzr7fh79",
      "InspectionName": "nis巡检",
      "Status": "Active",
      "InspectionProject": "basic",
      "CreateTime": "2024-06-18 00:14:46",
      "LastUpdateReportId": "nir-b4c4c9******8a25e"
    }
  ],
  "NextToken": "hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj",
  "MaxResults": 20,
  "TotalCount": 5
}

错误码

HTTP status code

错误码

错误信息

描述

400 IllegalParam.NextToken The specified argument NextToken(%s) is illegal. 指定的参数NextToken(%s)不合法。
400 IllegalParam.Status The specified Status(%s) parameter is illegal. 指定的Status(%s)参数不合法。
400 IllegalParam.InspectionProject The specified argument InspectionProject(%s) is illegal. 指定的参数InspectionProject不合法。

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

变更历史

更多信息,参考变更详情