获取数据投递任务列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /delivery-tasks HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| keyWords |
string |
否 |
按任务名称或任务 ID 模糊查询（like 语义） |
test-task |
| resourceGroupId |
string |
否 |
资源组 ID |
rg-aek2bhocin5e2na |
| nextToken |
string |
否 |
翻页 Token，首次请求不填，后续传入上次返回的 nextToken |
sjC5rekx93Ew7K7VcmI3wkBZBYQ-GphB2ilQu3zJCGxoZuicwyJznfo2riTjr-lq |
| maxResults |
integer |
否 |
每页返回数量，默认 20，最大 100 |
100 |
| tag |
array<object> |
否 |
标签列表 |
|
|
object |
否 |
标签列表 |
||
| value |
string |
否 |
标签值 |
value1 |
| key |
string |
否 |
标签键 |
testKey |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回值结构体 |
||
| maxResults |
integer |
最大返回结果数，最大值 100 |
100 |
| nextToken |
string |
下一页分页 Token |
2-ba4d-4b9f-aa24-dcb067a30f1c |
| totalCount |
integer |
总任务数 |
100 |
| deliveryTasks |
array<object> |
投递任务列表 |
|
|
array<object> |
投递任务 |
||
| labelFiltersType |
string |
指标过滤模式 枚举值：
|
Allow |
| externalLabels |
object |
为所有投递指标附加的额外 label，key 为 label 名，value 为 label 值 |
|
|
string |
externalLabelsKey → externalLabelsValue，例如 region → cn-hangzhou |
region: cn-hangzhou |
|
| sinkList |
array<object> |
投递目标列表，支持配置多个 sink |
|
|
array<object> |
投递目标配置 |
||
| sinkConfigs |
object |
投递目标详细配置，key/value 含义因 sinkType 不同而不同 |
|
|
string |
各 sinkType 支持的配置项 |
Url: http://xxxx/api/v1/write |
|
| sinkType |
string |
投递目标类型 枚举值：
|
Prometheus |
| taskDescription |
string |
任务描述 |
my delivery task |
| updateTime |
string |
更新时间 |
2026-01-22T09:02:01Z |
| tags |
array<object> |
标签 |
|
|
object |
标签 |
||
| value |
string |
标签值 |
value |
| key |
string |
标签键 |
key |
| dataSourceId |
string |
数据源 ID（Prometheus 实例 ID） |
rw-5f2b4c7e66342s |
| createTime |
string |
创建时间 |
2026-01-22T09:02:01Z |
| labelFilters |
object |
指标过滤条件，配合 labelFiltersType 使用，key 为指标 label 名，value 为匹配值 |
|
|
string |
filterKey → filterValue，例如 name → up，job → my_job |
__name__: up |
|
| taskName |
string |
任务名称 |
test-task |
| resourceGroupId |
string |
资源组 ID |
rg-acfm3gn5i6bigbi |
| taskId |
string |
任务 ID |
db21f8a126d96953 |
| status |
string |
任务当前状态 枚举值：
|
Enable |
| extraInfo |
object |
扩展信息。 |
|
| taskNameList |
array |
EventBridge 任务列表 |
|
|
string |
EventBridge 任务 |
prometheus-deliver-98e367d8fb8cc83b-0 |
|
| requestId |
string |
请求 ID |
7D7DF334-B2F2-5453-AD51-A27B337E3191 |
示例
正常返回示例
JSON格式
{
"maxResults": 100,
"nextToken": "2-ba4d-4b9f-aa24-dcb067a30f1c",
"totalCount": 100,
"deliveryTasks": [
{
"labelFiltersType": "Allow",
"externalLabels": {
"key": "region: cn-hangzhou"
},
"sinkList": [
{
"sinkConfigs": {
"key": "Url: http://xxxx/api/v1/write"
},
"sinkType": "Prometheus"
}
],
"taskDescription": "my delivery task",
"updateTime": "2026-01-22T09:02:01Z",
"tags": [
{
"value": "value",
"key": "key"
}
],
"dataSourceId": "rw-5f2b4c7e66342s",
"createTime": "2026-01-22T09:02:01Z",
"labelFilters": {
"key": "__name__: up"
},
"taskName": "test-task",
"resourceGroupId": "rg-acfm3gn5i6bigbi",
"taskId": "db21f8a126d96953",
"status": "Enable",
"extraInfo": {
"taskNameList": [
"prometheus-deliver-98e367d8fb8cc83b-0"
]
}
}
],
"requestId": "7D7DF334-B2F2-5453-AD51-A27B337E3191"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。