UpdateDeliveryTask - 更新数据投递任务

更新时间:
复制为 MD 格式

更新数据投递任务。更新语义为 Patch:未填写的字段保持不变。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

PUT /delivery-task/{taskId} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

taskId

string

任务 ID

6afe16bece7996a3

请求参数

名称

类型

必填

描述

示例值

body

object

请求体,所有字段均为可选,仅填写需要变更的字段

taskName

string

任务名称,支持中文、英文、下划线、中划线

new-task-name

dataSourceId

string

数据源 ID(Prometheus 实例 ID)

rw-5f2b4sc7es4d66

taskDescription

string

任务描述

updated desc

status

string

任务状态,用于启停任务

枚举值:

  • Enable :

    Enable

  • Disable :

    Disable

Enable

labelFiltersType

string

指标过滤模式

Deny

labelFilters

object

指标过滤条件,整体替换,不做增量合并

string

filterKey → filterValue,例如 job → my_job

__name__: up

externalLabels

object

为所有投递指标附加的额外 label,key 为 label 名,value 为 label 值

string

externalLabelsKey → externalLabelsValue,例如 region → cn-hangzhou

region: cn-hangzhou

sinkList

array<object>

投递目标列表

array<object>

投递目标

sinkType

string

投递目标类型

Prometheus

sinkConfigs

object

投递目标详细配置,key/value 含义因 sinkType 不同而不同

string

各 sinkType 支持的配置项

Url: http://xxxx/api/v1/write

resourceGroupId

string

资源组 ID

rg-aekzoiafjtr7zyq

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

9335D7CB-2725-53DD-A2B3-187821C8F1B8

示例

正常返回示例

JSON格式

{
  "requestId": "9335D7CB-2725-53DD-A2B3-187821C8F1B8"
}

错误码

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

变更历史

更多信息,参考变更详情