创建数据投递任务，将指定数据源的指标数据投递至目标存储或消息队列，支持 Prometheus Remote Write、Kafka、MaxCompute 三种投递类型。支持通过标签过滤指定投递的指标范围，以及为投递指标附加自定义标签。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /delivery-tasks HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求体 |
|
| taskName |
string |
是 |
任务名称，支持中文、英文、下划线、中划线 |
my-task |
| dataSourceId |
string |
是 |
数据源 ID（Prometheus 实例 ID） |
rw-xxxxxx |
| taskDescription |
string |
否 |
任务描述 |
my delivery task |
| labelFiltersType |
string |
否 |
指标过滤模式 |
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 |
|
| 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-ae******ey |
| tags |
array<object> |
否 |
资源标签 |
|
|
object |
否 |
资源标签 |
||
| key |
string |
否 |
资源组标签的键。 |
_cms_workspace |
| value |
string |
否 |
资源组标签的值。 |
test |
sinkConfigs 配置项说明
sinkType = Prometheus
| key | 是否必填 | 说明 | 示例值 | 枚举值 |
| Url | 是 | Remote Write 写入地址 | http://xxxx/api/v1/write | |
| Network | 否 | 网络类型 | PublicNetwork | - PublicNetwork（公网） - PrivateNetwork（私网/VPC） |
| VpcId | 否 | VPC ID，Network 为 PrivateNetwork 时填写 | vpc-xxxxxx | |
| VSwtichId | 否 | VSwitch ID | vsw-xxxxxx | |
| SecurityGroupId | 否 | 安全组 ID | sg-xxxxxx | |
| Header | 否 | 自定义 HTTP Header，需为 JSON 格式的 Map 字符串 | {"aaa":"bbb","ccc":"ddd"} | |
| AuthType | 否 | 认证类型 | BasicAuth | - BasicAuth - None |
| Username | 否 | BasicAuth 用户名，AuthType 为 BasicAuth 时填写 | admin | |
| Password | 否 | BasicAuth 密码，AuthType 为 BasicAuth 时填写 | xxxxxx |
sinkType = AcsKafka
| key | 是否必填 | 说明 | 示例值 |
| InstanceId | 是 | Kafka 实例 ID | alikafka_xxxxx |
| Topic | 是 | Kafka Topic 名称 | my-topic |
sinkType = AcsMaxCompute
| key | 是否必填 | 说明 | 示例值 |
| ServiceName | 是 | MaxCompute 服务名 | my-mc-service |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
Id of the request |
4CB23A2E-B426-5D4B-9AA2-6C7A508D954B |
| taskId |
string |
投递任务 ID |
98e367d8fb8cc83b |
示例
正常返回示例
JSON格式
{
"requestId": "4CB23A2E-B426-5D4B-9AA2-6C7A508D954B",
"taskId": "98e367d8fb8cc83b"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。