DescribeBenchmarkTask - 查看压测任务详情

查看指定压测任务的详细配置信息。

调试

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

授权信息

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

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

请求语法

GET /api/v2/benchmark-tasks/{ClusterId}/{TaskName} HTTP/1.1

请求参数

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

压测任务所在区域。

cn-shanghai
TaskNamestring

压测任务名称。如何获取压测任务名称,请参见 ListBenchmarkTask

benchmark-larec-test-eac4

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

40325405-579C-4D82****
TaskNamestring

压测任务名称。

benchmark-larec-test-ae70
TaskIdstring

压测任务 ID。

eas-b-gv4y86u****
ServiceNamestring

待压测的服务名称。

foo
Tokenstring

创建压测任务的鉴权凭证。

6062787a-9301****
CallerUidstring

当前调用者 ID。

1640133467****
ParentUidstring

当前调用的主账号。

1029728669****
DesiredAgentlong

预期的压测实例个数。

4
AvailableAgentlong

可用的压测实例个数。

4
Statusstring

压测任务的执行状态。

枚举值:
  • Creating创建中:Creating
  • Starting启动中:Starting
  • DeleteFailed删除失败:DeleteFailed
  • Running运行中:Running
  • Stopping停止中:Stopping
  • Error报错:Error
  • Updating更新中:Updating
  • Deleting删除中:Deleting
  • CreateFailed创建失败:CreateFailed
Running
Reasonstring

压测任务处于当前状态的事件或原因。

RUNNING
Messagestring

压测任务执行状态的摘要信息。

Benchmar task is Running
Endpointstring

服务网关 Endpoint。

192342311234.pai-eas.cn-chengdu.aliyuncs.com

示例

正常返回示例

JSON格式

{
  "RequestId": "40325405-579C-4D82****",
  "TaskName": "benchmark-larec-test-ae70",
  "TaskId": "eas-b-gv4y86u****",
  "ServiceName": "foo",
  "Token": "6062787a-9301****",
  "CallerUid": "1640133467****",
  "ParentUid": "1029728669****",
  "DesiredAgent": 4,
  "AvailableAgent": 4,
  "Status": "Running",
  "Reason": "RUNNING",
  "Message": "Benchmar task is Running",
  "Endpoint": "192342311234.pai-eas.cn-chengdu.aliyuncs.com"
}

错误码

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

变更历史

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