建立資料投遞任務，將指定資料來源的指標資料投遞至目標儲存或訊息佇列，支援 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"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。