TriggerPatrol - 触发巡检

更新时间:
复制 MD 格式

触发巡检

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

stream:TriggerPatrol

create

*全部资源

*

无 无

请求语法

POST /autopilot/v2/namespaces/{namespace}/patrol-reports/trigger HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

namespace

string

是

项目空间名称。

default-namespace

请求参数

名称

类型

必填

描述

示例值

workspace

string

是

工作空间 ID。

a14bd5d90a****

body

object

否

触发巡检请求体。

scopeType

string

是

巡检范围类型。

枚举值:

  • ALL :

    全部部署

  • DEPLOYMENTS :

    指定部署

  • TAGS :

    按标签筛选部署

ALL

scopeConfig

object

否

巡检范围配置。

deploymentIds

array

否

部署 ID 列表。scopeType 为 DEPLOYMENTS 时有效。

string

否

部署 ID

00000000-0000-0000-0000-0000012312****

tags

object

否

标签映射。scopeType 为 TAGS 时有效。key 为标签名,value 为标签值列表。

{"environment":["production"]}

array

否

标签的键值对

string

否

标签值

"tag_key": ["v1", "v2"]

返回参数

名称

类型

描述

示例值

object

响应数据。

requestId

string

请求 ID。

CBC799F0-AS7S-1D30-8A4F-882ED4DD****

success

boolean

表示业务请求是否成功。

true

httpCode

integer

业务状态码,统一为 200;使用 success 表示业务请求是否成功。

200

errorCode

string

当 success 为 false 时,该值不为空,表示业务错误码;当 success 为 true 时,该值为空。

""

errorMessage

string

当 success 为 false 时,该值不为空,表示业务错误信息;当 success 为 true 时,该值为空。

""

data

object

触发巡检响应数据。

reportId

string

生成的报告 ID。

inspection-cf8f8843-64e4-4b45-9500-06790107130f

status

string

报告状态。

枚举值:

  • IN_PROGRESS :

    进行中

  • COMPLETED :

    已完成

  • FAILED :

    已失败

  • PENDING :

    等待中

COMPLETED

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "reportId": "inspection-cf8f8843-64e4-4b45-9500-06790107130f",
    "status": "COMPLETED"
  }
}

错误码

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

变更历史

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