ListBenchmarkTask - 查询压测任务列表

查看当前用户部署的所有压测任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eas:ListBenchmarkTasklist
*BenchmarkTask
acs:eas:{#regionId}:{#accountId}:benchmarktask/*

请求语法

GET /api/v2/benchmark-tasks HTTP/1.1

请求参数

名称类型必填描述示例值
Filterstring

过滤参数。如果指定,将分别查找 EAS 服务名和压测任务名中和指定参数匹配的记录。

test_bench
ServiceNamestring

压测任务对应的 EAS 服务名称。如何查询服务名称,请参见 ListServices

test_bench_srv
PageNumberstring

压测任务列表的页码。起始值为 1,默认为 1。

1
PageSizestring

分页查询时设置的每页显示的压测任务数量,默认为 100。

10

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

40325405-579C-4D82****
Tasksarray<object>

任务列表。

Taskobject

任务详情。

TaskNamestring

压测任务名称。

benchmark-larec-test-1076
TaskIdstring

压测任务 ID。

eas-b-gv4y86uvgt****i
ServiceNamestring

待压测的服务名称。

test_quota
Regionstring

压测任务所在区域。

cn-shanghai
AvailableAgentlong

可用的压测实例个数。

2
Statusstring

压测任务的状态。

枚举值:
  • CreatingCreating
  • StartingStarting
  • DeleteFailedDeleteFailed
  • RunningRunning
  • StoppingStopping
  • ErrorError
  • UpdatingUpdating
  • DeletingDeleting
  • CreateFailedCreateFailed
Running
Messagestring

服务的摘要信息。

Benchmark task [benchmark-larec-test-1076] is Running
CreateTimestring

压测任务的创建时间。

2020-12-04T02:43:15Z
UpdateTimestring

压测任务的更新时间。

2020-06-24T03:11:30Z
TotalCountinteger

查询到的任务总数。

2
PageNumberinteger

返回查询的压测任务列表的页码。

1
PageSizeinteger

返回每页显示的压测任务数量。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "40325405-579C-4D82****",
  "Tasks": [
    {
      "TaskName": "benchmark-larec-test-1076",
      "TaskId": "eas-b-gv4y86uvgt****i",
      "ServiceName": "test_quota",
      "Region": "cn-shanghai",
      "AvailableAgent": 2,
      "Status": "Running",
      "Message": "Benchmark task [benchmark-larec-test-1076] is Running",
      "CreateTime": "2020-12-04T02:43:15Z",
      "UpdateTime": "2020-06-24T03:11:30Z"
    }
  ],
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 20
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史