Get the run records of a benchmark task

Use this API to get the execution history of a benchmark task. One benchmark task can be executed many times, periodically or manually by users. Each execution creates a run record.

Resource Information

Method

URL

Authentication

GET

/V1/CMDB/Benchmark/Tasks/{task}/Runs

Yes

Parameters

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

task*required
(path)

The ID or name of the benchmark task.

Response

Parameter

Type

Description

Example

runs

object

An object with the historical record of each run. Each execution creates a run record.

{
  "runs": [
    {
      "runId": "string",
      "startTime": "string",
      "endTime": "string",
      "status": 10,
      "isFinished": true,
      "isStopByUser": true
    }
  ],
  "statusCode": 790200,
  "statusDescription": "success"
}

runId

string

The ID for every specific run.

startTime

string

The start time of a specific run.

endTime

string

The end time of a specific run.

status

integer

The status of a scheduled task. Possible values:

▪1: Unknown

▪0: Never run

▪2: Running

▪10: Succeeded

▪11: Succeeded with warnings

▪20: Failed

▪30: Manually stopped

▪31: Automatically stopped due to timeout set by users or another system setting

isFinished

bool

Whether a scheduled task is finished.

isStopByUser

bool

Whether a scheduled task is manually stopped by users.

statusCode

integer

The returned status code of executing the API.

statusDescription

string

The explanation of the status code.