API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(PTS/2020-10-20)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

PTS压测

API

标题

API概述

压测基线 压测基线
CreatePtsSceneBaseLineFromReport 创建场景基线 将一个报告数据设置为场景基线。
DeletePtsSceneBaseLine 删除场景基线 删除场景设置的基线信息。
UpdatePtsSceneBaseLine 修改场景基线 更新一个场景的基线数据。
GetPtsSceneBaseLine 查询场景基线 查询场景设置的基线数据。
压测报告 压测报告
ListPtsReports 查询PTS报告列表 根据条件列出PTS报告的概要信息。
GetPtsReportDetails 查询报告 获取场景压测后的报告详情。
GetPtsReportsBySceneId 查询场景关联的所有报告 场景压测产生多个场景,可批量查询关联的所有报告。
GetPtsDebugSampleLogs 获取PTS场景调试日志 查询PTS场景调试任务的采样日志。
压测执行 压测执行
StartDebugPtsScene 启动场景调试 启动场景的调试,了解配置信息是否通。
StartPtsScene 启动场景 启动场景入参为场景ID。
StopDebugPtsScene 停止场景调试 停止正在调试中的场景。
StopPtsScene 停止场景 停止场景入参为场景ID。
GetPtsSceneRunningData 获取压测实时数据 场景压测或调试中获取场景的运行时数据。
GetPtsSceneRunningStatus 获取场景运行时状态 场景启动压测后,获取运行时状态。
AdjustPtsSceneSpeed PTS场景调速 调整PTS场景压力值。
压测场景 压测场景
CreatePtsScene 创建场景 创建压测场景。
SavePtsScene 保存或修改场景 保存或修改场景。
DeletePtsScene 删除场景 删除场景,一次删除一个。
DeletePtsScenes 批量删除场景 一次批量删除多个场景。
ModifyPtsScene 修改场景 修改场景配置信息,比如URL、施压信息。
GetPtsScene 查询场景 查询场景的结构、施压等信息。
ListPtsScene 分页查询场景 分页查询场景概览信息。

JMeter压测

API

标题

API概述

压测报告 压测报告
GetJMeterReportDetails 获取JMeter报告详情 查询JMeter报告详情。
GetJMeterLogs 获得JMeter运行日志 获得JMeter运行日志。默认查询第0台机器的日志,并返回机器总数。
GetJMeterSampleMetrics JMeter采样器聚合数据 根据条件获得JMeter采样器聚合数据。
GetJMeterSamplingLogs JMeter采样器日志 根据条件获得JMeter采样器的采样日志。
ListJMeterReports JMeter报告列表 根据条件列出JMeter报告的概要信息。
压测执行 压测执行
StartDebuggingJMeterScene 调试场景 开始调试JMeter场景。
StartTestingJMeterScene 压测场景 开始压测JMeter场景。
StopDebuggingJMeterScene 停止调试 停止JMeter场景调试。
StopTestingJMeterScene 停止压测 停止JMeter场景压测。
GetJMeterSceneRunningData 获得压测运行时数据 根据场景ID获取JMeter场景压测过程中的数据。
AdjustJMeterSceneSpeed 压测中调整JMeter线程数 调整jmeter压力大小。
压测场景 压测场景
RemoveOpenJMeterScene 移除场景 移除JMeter场景。
SaveOpenJMeterScene 保存场景 新建或更新JMeter场景。
GetOpenJMeterScene 场景详情 获得JMeter场景详情。
ListOpenJMeterScenes JMeter场景列表 根据条件获得JMeter场景列表。
压测环境 压测环境
RemoveEnv 移除环境 根据JMeter环境ID移除JMeter环境。
SaveEnv 保存环境 新建或更新JMeter环境。
ListEnvs 环境列表 根据条件列出JMeter环境。

其他

API

标题

API概述

GetAllRegions 获取VPC可用Region列表 获取所有的region。