Load Test Run - List Metrics
ロード テストの実行のメトリック値を一覧表示します。
POST https://{endpoint}/test-runs/{testRunId}/metrics?api-version=2022-11-01&metricname={metricname}&metricNamespace={metricNamespace}×pan={timespan}
POST https://{endpoint}/test-runs/{testRunId}/metrics?api-version=2022-11-01&aggregation={aggregation}&metricname={metricname}&interval={interval}&metricNamespace={metricNamespace}×pan={timespan}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
test
|
path | True |
string minLength: 2maxLength: 50 pattern: ^[a-z0-9_-]*$ |
ロード テストの実行の一意の名前。小文字の英字、数字、アンダースコア、またはハイフン文字のみを含める必要があります。 |
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
metricname
|
query | True |
string |
メトリック名 |
metric
|
query | True |
string |
メトリック定義のクエリを実行するメトリック名前空間。 |
timespan
|
query | True |
string |
クエリの期間。 "startDateTime_ISO/endDateTime_ISO" という形式の文字列です。 |
aggregation
|
query |
string |
集計 |
|
interval
|
query |
クエリの間隔 (つまり timegrain)。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
filters |
特定のディメンション値のメトリックを取得します。 例: メトリックには、SamplerName、Error などのディメンションが含まれています。 SamplerName が HTTPRequest1 または HTTPRequest2 と等しいすべての時系列データを取得するには、DimensionFilter の値は {"SamplerName"、["HTTPRequest1"、"HTTPRequest2"} になります。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 ヘッダー x-ms-error-code: string |
セキュリティ
Oauth2
Microsoft Entra ID を使用した OAuth 2.0 Flow。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ
名前 | 説明 |
---|---|
https://cnt-prod.loadtesting.azure.com/.default |
例
List the metric values for a load test run.
要求のサンプル
POST https://{endpoint}/test-runs/12316678-1234-1234-1234-122451189012/metrics?api-version=2022-11-01&aggregation=Average&metricname=ActiveThreads&interval=PT1H&metricNamespace=LoadTestRunMetrics×pan=2022-09-24T19:00:40Z/2022-09-25T19:28:40Z
{
"filters": [
{
"name": "SamplerName",
"values": [
"HTTP Request"
]
}
]
}
応答のサンプル
{
"value": [
{
"data": [
{
"timestamp": "2022-10-29T08:44:40.000Z",
"value": 10
},
{
"timestamp": "2022-10-29T08:44:45.000Z",
"value": 28
},
{
"timestamp": "2022-10-29T08:44:50.000Z",
"value": 45
},
{
"timestamp": "2022-10-29T08:44:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:25.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:30.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:35.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:40.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:45.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:50.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:45:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:25.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:30.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:35.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:40.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:45.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:50.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:46:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:25.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:30.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:35.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:40.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:45.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:50.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:47:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:25.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:30.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:35.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:40.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:45.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:50.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:48:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:25.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:30.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:35.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:40.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:45.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:50.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:49:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:25.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:30.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:35.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:40.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:45.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:50.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:50:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:25.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:30.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:35.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:40.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:45.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:50.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:51:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:25.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:30.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:35.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:40.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:45.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:50.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:52:55.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:53:00.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:53:05.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:53:10.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:53:15.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:53:20.000Z",
"value": 50
},
{
"timestamp": "2022-10-29T08:53:25.000Z",
"value": 49
}
],
"dimensionValues": [
{
"name": "SamplerName",
"value": "HighLoadTest"
}
]
}
]
}
定義
名前 | 説明 |
---|---|
Azure. |
エラー オブジェクト。 |
Azure. |
エラーの詳細を含む応答。 |
Azure. |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. |
Dimension |
フィルター処理するディメンションの名前と値 |
Dimension |
メトリック ディメンションの値を表します。 |
Metric |
メトリックのセットをフェッチするフィルター。 |
Metrics |
メトリック クエリへの応答。 |
Metric |
メトリック値を表します。 |
Time |
時間グレイン |
Time |
データ クエリの実行時に返される時系列。 |
Azure.Core.Foundations.Error
エラー オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
Azure.Core.Foundations.ErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
Azure.Core.Foundations.InnerError
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
innererror |
内部エラー。 |
DimensionFilter
フィルター処理するディメンションの名前と値
名前 | 型 | 説明 |
---|---|---|
name |
string |
ディメンション名 |
values |
string[] |
ディメンション値。 最大値は 20 です。 |
DimensionValue
メトリック ディメンションの値を表します。
名前 | 型 | 説明 |
---|---|---|
name |
string |
ディメンションの名前。 |
value |
string |
ディメンションの値。 |
MetricRequestPayload
メトリックのセットをフェッチするフィルター。
名前 | 型 | 説明 |
---|---|---|
filters |
特定のディメンション値のメトリックを取得します。 例: メトリックには、SamplerName、Error などのディメンションが含まれています。 SamplerName が HTTPRequest1 または HTTPRequest2 と等しいすべての時系列データを取得するには、DimensionFilter の値は {"SamplerName"、["HTTPRequest1"、"HTTPRequest2"} になります。 |
Metrics
メトリック クエリへの応答。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string (uri) |
アイテムの次のページへのリンク |
value |
このページの TimeSeriesElement 項目 |
MetricValue
メトリック値を表します。
名前 | 型 | 説明 |
---|---|---|
timestamp |
string (date-time) |
RFC 3339 形式のメトリック値のタイムスタンプ。 |
value |
number (double) |
メトリック値。 |
TimeGrain
時間グレイン
値 | 説明 |
---|---|
PT10S |
10 秒。テストの実行時間が 10 分未満の場合にのみ使用できます。 |
PT1H |
1 時間。テストの実行時間が 1 分を超える場合にのみ使用できます。 |
PT1M |
1 分 |
PT5M |
5 分。テストの実行時間が 1 分を超える場合にのみ使用できます。 |
PT5S |
5 秒。テストの実行時間が 10 分未満の場合にのみ使用できます。 |
TimeSeriesElement
データ クエリの実行時に返される時系列。
名前 | 型 | 説明 |
---|---|---|
data |
メトリック値を表すデータ ポイントの配列。 |
|
dimensionValues |
ディメンション値 |