メトリックデータをデータソースからストレージ送信先またはメッセージキューへ配信するデータ配信タスクを作成します。このタスクは、Prometheus Remote Write、Kafka、MaxCompute の 3 種類の配信タイプをサポートしています。また、ラベルによる配信対象メトリックのフィルター処理や、カスタムタグの付与も可能です。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /delivery-tasks HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストボディです。 |
|
| taskName |
string |
必須 |
タスク名です。中国語文字、英字、アンダースコア (_ )、ハイフン ( - ) を使用できます。 |
my-task |
| dataSourceId |
string |
必須 |
データソースとして機能する Prometheus インスタンスの ID です。 |
rw-xxxxxx |
| taskDescription |
string |
任意 |
タスクの説明です。 |
my delivery task |
| labelFiltersType |
string |
任意 |
ラベルフィルターの適用モードです。 |
Allow |
| labelFilters |
object |
任意 |
メトリックをフィルターするためのラベル条件です。キーはラベル名、値は一致させる値です。フィルター動作は |
|
|
string |
任意 |
フィルター条件を指定するキーと値のペアです。例： |
__name__: up |
|
| externalLabels |
object |
任意 |
配信されるすべてのメトリックに追加ラベルとして付与する、キーと値のペアのマップです。 |
|
|
string |
任意 |
外部ラベルのキーと値のペアです。例： |
region: cn-hangzhou |
|
| sinkList |
array<object> |
必須 |
配信送信先オブジェクトの配列です。 |
|
|
array<object> |
必須 |
配信送信先の構成を含むオブジェクトです。 |
||
| sinkType |
string |
必須 |
配信送信先（sink）のタイプです。 |
Prometheus |
| sinkConfigs |
object |
任意 |
送信先の構成です。キーと値のペアで指定します。 |
|
|
string |
任意 |
送信先の構成設定です。 |
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
| キー | 必須 | 説明 | 例 | 列挙値 |
| Url | はい | Remote Write エンドポイントです。 | http://xxxx/api/v1/write | |
| Network | いいえ | ネットワークタイプです。 | PublicNetwork | - PublicNetwork（パブリックネットワーク） - PrivateNetwork（プライベートネットワーク／VPC） |
| VpcId | いいえ | VPC ID です。Network が PrivateNetwork の場合に必須です。 | vpc-xxxxxx | |
| VSwitchId | いいえ | VSwitch ID です。 | vsw-xxxxxx | |
| SecurityGroupId | いいえ | セキュリティグループ ID です。 | sg-xxxxxx | |
| Header | いいえ | カスタム HTTP ヘッダーです。JSON 形式のマップ文字列で指定します。 | {"aaa":"bbb","ccc":"ddd"} | |
| AuthType | いいえ | 認証タイプです。 | BasicAuth | - BasicAuth - None |
| Username | いいえ | 基本認証のユーザー名です。AuthType が BasicAuth の場合に必須です。 | admin | |
| Password | いいえ | 基本認証のパスワードです。AuthType が BasicAuth の場合に必須です。 | xxxxxx |
sinkType = AcsKafka
| キー | 必須 | 説明 | 例 |
| InstanceId | はい | Kafka インスタンス ID です。 | alikafka_xxxxx |
| Topic | はい | Kafka トピック名です。 | my-topic |
sinkType = AcsMaxCompute
| キー | 必須 | 説明 | 例 |
| ServiceName | はい | MaxCompute サービス名です。 | my-mc-service |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答で返されるデータです。 |
||
| requestId |
string |
リクエストを一意に識別する ID です。 |
4CB23A2E-B426-5D4B-9AA2-6C7A508D954B |
| taskId |
string |
データ配信タスクの ID です。 |
98e367d8fb8cc83b |
例
成功レスポンス
JSONJSON
{
"requestId": "4CB23A2E-B426-5D4B-9AA2-6C7A508D954B",
"taskId": "98e367d8fb8cc83b"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。