GetDeliveryTask - 获取数据投递任务-云监控(CMS)-阿里云帮助中心

获取数据投递任务详情

调试

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

授权信息

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

请求语法

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

路径参数

名称	类型	必填	描述	示例值
taskId	string	是	投递任务 ID	98e367d8fb8cc83b

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	返回结构体
deliveryTask	object	投递任务详情
taskId	string	投递任务 ID	8b07eeac8249866d
taskName	string	任务名称	test-task
taskDescription	string	任务描述	my delivery task
status	string	任务当前状态	Pending2Running
dataSourceId	string	数据源 id（Prometheus 实例 ID)	rw-xxxxxx
labelFiltersType	string	指标过滤模式枚举值： Deny : Deny Allow : Allow	Allow
labelFilters	object	指标过滤条件，配合 labelFiltersType 使用，key 为指标 label 名，value 为匹配值
	string	filterKey → filterValue，例如 name → up，job → my_job	__name__: up
externalLabels	object	为所有投递指标附加的额外 label，key 为 label 名，value 为 label 值
	string	externalLabelsKey → externalLabelsValue，例如 region → cn-hangzhou	region: cn-hangzhou
createTime	string	创建时间	2025-07-24T02:08:27Z
updateTime	string	更新时间	2026-01-22T11:50:48Z
extraInfo	object	扩展信息。
taskNameList	array	EventBridge 任务列表
	string	EventBridge 任务名称	prometheus-deliver-98e367d8fb8cc83b-0
sinkList	array<object>	投递目标列表
	array<object>	投递目标配置
sinkType	string	投递目标类型枚举值： AcsKafka : AcsKafka Prometheus : Prometheus AcsMaxcompute : AcsMaxcompute	Prometheus
sinkConfigs	object	投递目标详细配置，key/value 含义因 sinkType 不同而不同（见 CreateDeliveryTask 说明）
	string	各 sinkType 支持的配置项	Url: http://xxxx/api/v1/write
regionId	string	地域 ID。	cn-chengdu
tags	array<object>	资源组标签的键。
	object	Tag 的值。
key	string	资源组标签键	sourcetype
value	string	资源组标签值	production
requestId	string	请求 ID。	0CEC5375-C554-562B-A65F-9A629907C1F0

示例

正常返回示例

JSON格式

{
  "deliveryTask": {
    "taskId": "8b07eeac8249866d",
    "taskName": "test-task",
    "taskDescription": "my delivery task",
    "status": "Pending2Running",
    "dataSourceId": "rw-xxxxxx",
    "labelFiltersType": "Allow",
    "labelFilters": {
      "key": "__name__: up"
    },
    "externalLabels": {
      "key": "region: cn-hangzhou"
    },
    "createTime": "2025-07-24T02:08:27Z",
    "updateTime": "2026-01-22T11:50:48Z",
    "extraInfo": {
      "taskNameList": [
        "prometheus-deliver-98e367d8fb8cc83b-0"
      ]
    },
    "sinkList": [
      {
        "sinkType": "Prometheus",
        "sinkConfigs": {
          "key": "Url: http://xxxx/api/v1/write"
        }
      }
    ],
    "regionId": "cn-chengdu",
    "tags": [
      {
        "key": "sourcetype",
        "value": "production"
      }
    ]
  },
  "requestId": "0CEC5375-C554-562B-A65F-9A629907C1F0"
}

错误码

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

变更历史

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