VPC環境で利用できます。
ジョブの実行数と成功、失敗数を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api/v1/stats/executions |
リクエストヘッダ
Data Flow APIで共通して使用されるヘッダの詳細は、Data Flowのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
startDate |
String | Required | 照会開始日時
|
endDate |
String | Required | 照会終了日時
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/stats/executions?startDate=2025-03-19T00%3A00%3A00&endDate=2025-03-20T23%3A59%3A59' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
totalCount |
Integer | - | 総実行回数 |
completedCount |
Integer | - | 成功回数 |
failedCount |
Integer | - | 失敗回数 |
レスポンスステータスコード
Data Flow APIで共通して使用されるレスポンスステータスコードの詳細は、Data Flow APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"totalCount": 4,
"completedCount": 3,
"failedCount": 1
}