{ "name": "pts", "display_name": "云压测", "description": "## 概述云压测（Performance Testing Service, 以下简称PTS）是一款分布式性能测试服务，可模拟海量用户的真实业务场景，全方位验证系统可用性和稳定性。支持按需发起压测任务，提供百万并发多地域流量发起能力。提供流量录制、场景编排、流量定制、高级脚本定制等功能，可快速根据业务模型定义压测场景，真实还原应用大规模业务访问场景，帮助用户提前识别应用性能问题\ufffd\ufffd...", "domain": "other", "api_version": "2021-07-28", "endpoint": "pts.tencentcloudapi.com", "actions": [ { "name": "AbortCronJobs", "description": "停止定时任务", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "CronJobIds", "type": "array", "required": true, "description": "定时任务ID数组", "example": "[\"cron-xx\"]", "item_type": "string" } ], "required": [ "ProjectId", "CronJobIds" ] }, { "name": "AbortJob", "description": "停止任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "待停止的压测任务的 ID（所有的压测任务 ID 可以从 DescribeJobs 接口获取）", "example": "job-xx" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-xx" }, { "name": "AbortReason", "type": "integer", "required": false, "description": "中断原因", "example": "0 unknown reason; 1 abort by user; 2 abort by sla rules" } ], "required": [ "JobId", "ProjectId", "ScenarioId" ] }, { "name": "AdjustJobSpeed", "description": "调整任务的目标RPS", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务ID", "example": "job-xxx" }, { "name": "TargetRequestsPerSecond", "type": "integer", "required": true, "description": "目标 RPS。其取值应大于起始 RPS，并且小于最大 RPS", "example": "60" }, { "name": "ProjectId", "type": "string", "required": false, "description": "压测项目ID", "example": "project-12345" }, { "name": "ScenarioId", "type": "string", "required": false, "description": "测试场景ID", "example": "scenario-12345" } ], "required": [ "JobId", "TargetRequestsPerSecond" ] }, { "name": "CopyScenario", "description": "复制场景", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目 ID", "example": "project-xx" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景 ID", "example": "scenario-xx" } ], "required": [ "ProjectId", "ScenarioId" ] }, { "name": "CreateAlertChannel", "description": "创建告警通知接收组", "status": "online", "parameters": [ { "name": "NoticeId", "type": "string", "required": true, "description": "monitor 服务的告警通知模板的 NoticeId，可从 monitor 服务的云 API 的 DescribeAlarmNotices 接口响应里的 Id 字段获取。（CreateAlertChannel 接口的入参里用于标识一个告警通知模板的 AMPConsumerId 与 NoticeId 二选一即可）", "example": "notice-xx" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目 ID", "example": "project-xx" }, { "name": "AMPConsumerId", "type": "string", "required": false, "description": "monitor 服务的告警通知模板的 AMPConsumerId，可从 monitor 服务的云 API 的 DescribeAlarmNotices 接口响应里的 AMPConsumerId 字段获取。（CreateAlertChannel 接口的入参里用于标识一个告警通知模板的 AMPConsumerId 与 NoticeId 二选一即可）", "example": "consumer-xx" } ], "required": [ "NoticeId", "ProjectId" ] }, { "name": "CreateCronJob", "description": "创建定时任务", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "定时任务名字", "example": "cronjob" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-xx" }, { "name": "ScenarioName", "type": "string", "required": true, "description": "场景名称", "example": "scenario name" }, { "name": "FrequencyType", "type": "integer", "required": true, "description": "执行频率类型，1:只执行一次; 2:日粒度; 3:周粒度; 4:高级", "example": "1" }, { "name": "CronExpression", "type": "string", "required": true, "description": "cron表达式", "example": "*/1 * * * *" }, { "name": "JobOwner", "type": "string", "required": true, "description": "任务发起人", "example": "tom" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2014-08-03T12:00:00+08:00" }, { "name": "NoticeId", "type": "string", "required": false, "description": "Notice ID", "example": "notice-xx" }, { "name": "Note", "type": "string", "required": false, "description": "备注", "example": "定时任务备注" } ], "required": [ "Name", "ProjectId", "ScenarioId", "ScenarioName", "FrequencyType", "CronExpression", "JobOwner" ] }, { "name": "CreateEnvironment", "description": "创建环境", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xxx" }, { "name": "Name", "type": "string", "required": true, "description": "环境名", "example": "test-env" }, { "name": "EnvVars", "type": "array", "required": true, "description": "环境变量", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "变量引用键，建议为 C_IDENTIFIER 全大写风格", "example": "C_NAME" }, { "name": "Type", "type": "string", "required": false, "description": "默认 NORMAL，支持 NORMAL、PASSWORD 类型", "example": "NORMAL" }, { "name": "Value", "type": "string", "required": false, "description": "变量引用值", "example": "value-xx" }, { "name": "Description", "type": "string", "required": false, "description": "描述内容", "example": "用于变量设置" } ] }, { "name": "Description", "type": "string", "required": false, "description": "环境描述", "example": "测试环境变量" } ], "required": [ "ProjectId", "Name", "EnvVars" ] }, { "name": "CreateFile", "description": "创建文件", "status": "online", "parameters": [ { "name": "FileId", "type": "string", "required": true, "description": "文件 ID。其值应为前序步骤上传该文件到 cos 桶后，文件在 cos 桶中的相应目录", "example": "file-235c3000" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目 ID", "example": "project-btksohr0" }, { "name": "Kind", "type": "integer", "required": true, "description": "文件种类，参数文件-1，协议文件-2，请求文件-3", "example": "1" }, { "name": "Name", "type": "string", "required": true, "description": "文件名", "example": "uin.csv" }, { "name": "Size", "type": "integer", "required": true, "description": "文件大小", "example": "3896" }, { "name": "Type", "type": "string", "required": true, "description": "文件类型，文件夹-folder", "example": "csv" }, { "name": "LineCount", "type": "integer", "required": false, "description": "行数", "example": "1001" }, { "name": "HeadLines", "type": "array", "required": false, "description": "前几行数据", "example": "[\"uin\",\"1\",\"2\"]", "item_type": "string" }, { "name": "TailLines", "type": "array", "required": false, "description": "后几行数据", "example": "[\"998\",\"999\",\"1000\"]", "item_type": "string" }, { "name": "HeaderInFile", "type": "boolean", "required": false, "description": "表头是否在文件内", "example": "true" }, { "name": "HeaderColumns", "type": "array", "required": false, "description": "表头", "example": "[\"uin\"]", "item_type": "string" }, { "name": "FileInfos", "type": "array", "required": false, "description": "文件夹中的文件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "文件名", "example": "a.log" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "csv" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] } ], "required": [ "FileId", "ProjectId", "Kind", "Name", "Size", "Type" ] }, { "name": "CreateProject", "description": "创建项目", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "项目名", "example": "project name" }, { "name": "Description", "type": "string", "required": false, "description": "项目描述", "example": "this is a test project" }, { "name": "Tags", "type": "array", "required": false, "description": "标签数组", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "owner" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tom" } ] } ], "required": [ "Name" ] }, { "name": "CreateScenario", "description": "创建场景", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "场景名", "example": "scenario-name" }, { "name": "Type", "type": "string", "required": true, "description": "压测引擎类型", "example": "pts-http, pts-js,pts-jmeter,pts-trpc" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "Description", "type": "string", "required": false, "description": "场景描述", "example": "this is a test scenario" }, { "name": "Load", "type": "object", "required": false, "description": "施压配置", "example": "无", "children": [ { "name": "LoadSpec", "type": "object", "required": false, "description": "施压配置", "example": "无", "children": [ { "name": "Concurrency", "type": "object", "required": false, "description": "并发施压模式的配置注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Stages", "type": "array", "required": false, "description": "多阶段配置数组注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "IterationCount", "type": "integer", "required": false, "description": "运行次数", "example": "10" }, { "name": "MaxRequestsPerSecond", "type": "integer", "required": false, "description": "最大RPS", "example": "1000" }, { "name": "GracefulStopSeconds", "type": "integer", "required": false, "description": "优雅终止任务的等待时间", "example": "3" }, { "name": "Resources", "type": "integer", "required": false, "description": "资源数", "example": "6" }, { "name": "Mode", "type": "string", "required": false, "description": "压力模型", "example": "不填代表梯度递增，spike: 浪涌模式，step: 梯度递增" } ] }, { "name": "RequestsPerSecond", "type": "object", "required": false, "description": "RPS施压模式的配置注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "MaxRequestsPerSecond", "type": "integer", "required": false, "description": "最大RPS", "example": "1000" }, { "name": "DurationSeconds", "type": "integer", "required": false, "description": "施压时间", "example": "60" }, { "name": "TargetVirtualUsers", "type": "integer", "required": false, "description": "deprecated", "example": "30" }, { "name": "Resources", "type": "integer", "required": false, "description": "资源数", "example": "6" }, { "name": "StartRequestsPerSecond", "type": "integer", "required": false, "description": "起始RPS", "example": "500" }, { "name": "TargetRequestsPerSecond", "type": "integer", "required": false, "description": "目标RPS，入参无效", "example": "500" }, { "name": "GracefulStopSeconds", "type": "integer", "required": false, "description": "优雅关停的等待时间", "example": "3" }, { "name": "IterationCount", "type": "integer", "required": false, "description": "场景最大执行次数", "example": "1000" } ] }, { "name": "ScriptOrigin", "type": "object", "required": false, "description": "脚本内置压力模式注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "MachineNumber", "type": "integer", "required": true, "description": "机器数量", "example": "10" }, { "name": "MachineSpecification", "type": "string", "required": true, "description": "机器规格", "example": "1c2g, 2c4g, 4g8g" }, { "name": "DurationSeconds", "type": "integer", "required": true, "description": "压测时长", "example": "1200" } ] } ] }, { "name": "VpcLoadDistribution", "type": "object", "required": false, "description": "压力来源注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "RegionId", "type": "integer", "required": true, "description": "地域ID", "example": "1" }, { "name": "Region", "type": "string", "required": false, "description": "地域", "example": "ap-guangzhou" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC ID", "example": "vpc-xx" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网ID列表注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"subnet-xxx\"]", "item_type": "string" } ] }, { "name": "GeoRegionsLoadDistribution", "type": "array", "required": false, "description": "多地域压力分布注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RegionId", "type": "integer", "required": true, "description": "地域ID", "example": "1" }, { "name": "Region", "type": "string", "required": false, "description": "地域", "example": "ap-guangzhou" }, { "name": "Percentage", "type": "integer", "required": false, "description": "百分比", "example": "50" } ] } ] }, { "name": "Configs", "type": "array", "required": false, "description": "deprecated", "example": "[\"a.prop\",\"b.prop\"]", "item_type": "string" }, { "name": "Datasets", "type": "array", "required": false, "description": "测试数据集", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "测试数据集所在的文件名", "example": "info.csv" }, { "name": "Split", "type": "boolean", "required": true, "description": "测试数据集是否分片", "example": "true" }, { "name": "HeaderInFile", "type": "boolean", "required": true, "description": "首行是否为参数名", "example": "true" }, { "name": "HeaderColumns", "type": "array", "required": false, "description": "参数名数组注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"name\", \"age\"]", "item_type": "string" }, { "name": "LineCount", "type": "integer", "required": false, "description": "文件行数", "example": "10" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "Size", "type": "integer", "required": false, "description": "文件字节数", "example": "10" }, { "name": "HeadLines", "type": "array", "required": false, "description": "头部数据行注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"head-line-value\"]", "item_type": "string" }, { "name": "TailLines", "type": "array", "required": false, "description": "尾部数据行注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"tail-line-value\"]", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "CSV" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] }, { "name": "Extensions", "type": "array", "required": false, "description": "deprecated", "example": "[\"a.jar\",\"b.jar\"]", "item_type": "string" }, { "name": "SLAId", "type": "string", "required": false, "description": "deprecated", "example": "sla-xx" }, { "name": "CronId", "type": "string", "required": false, "description": "cron job ID", "example": "cron-xx" }, { "name": "Scripts", "type": "array", "required": false, "description": "deprecated", "example": "[\"a.js\"]", "item_type": "string" }, { "name": "TestScripts", "type": "array", "required": false, "description": "测试脚本文件信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "文件名", "example": "hello.js" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "js" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "EncodedContent", "type": "string", "required": false, "description": "base64编码后的文件内容", "example": "sfadsfdsfdfdfsfdsgerdf" }, { "name": "EncodedHttpArchive", "type": "string", "required": false, "description": "base64编码后的har结构体", "example": "sfadsfdsfdfdfsfdsgerdf" }, { "name": "LoadWeight", "type": "integer", "required": false, "description": "脚本权重，范围 1-100", "example": "100" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xxx" }, { "name": "Uploaded", "type": "boolean", "required": false, "description": "文件是否已上传，如果已上传，则可以不必填写 EncodedContent,EncodedHar 等内容。主要用于较大长度脚本上传。", "example": "true/false" } ] }, { "name": "Protocols", "type": "array", "required": false, "description": "协议文件路径", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "协议详情", "example": "hello.proto" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "proto" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] }, { "name": "RequestFiles", "type": "array", "required": false, "description": "请求文件路径", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "文件名", "example": "a.log" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "csv" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] }, { "name": "SLAPolicy", "type": "object", "required": false, "description": "SLA 策略", "example": "无", "children": [ { "name": "SLARules", "type": "array", "required": false, "description": "SLA 规则注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Metric", "type": "string", "required": false, "description": "压测指标", "example": "pts_engine_req_total" }, { "name": "Aggregation", "type": "string", "required": false, "description": "压测指标聚合方法", "example": "avg" }, { "name": "Condition", "type": "string", "required": false, "description": "压测指标条件判断符号", "example": "\u003e" }, { "name": "Value", "type": "float", "required": false, "description": "阈值", "example": "1.00" }, { "name": "LabelFilter", "type": "array", "required": false, "description": "标签注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "标签名", "example": "service" }, { "name": "LabelValue", "type": "string", "required": false, "description": "标签值", "example": "http://httpbin.org/get" } ] }, { "name": "AbortFlag", "type": "boolean", "required": false, "description": "是否停止压测任务", "example": "true" }, { "name": "For", "type": "string", "required": false, "description": "持续时长", "example": "1m" } ] }, { "name": "AlertChannel", "type": "object", "required": false, "description": "告警通知渠道注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "NoticeId", "type": "string", "required": false, "description": "通知模板ID", "example": "notice-xx" }, { "name": "AMPConsumerId", "type": "string", "required": false, "description": "AMP consumer ID", "example": "consumer-xx" } ] } ] }, { "name": "Plugins", "type": "array", "required": false, "description": "拓展包文件路径", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "文件名", "example": "a.log" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "csv" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] }, { "name": "DomainNameConfig", "type": "object", "required": false, "description": "域名解析配置", "example": "无", "children": [ { "name": "HostAliases", "type": "array", "required": false, "description": "域名绑定配置注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HostNames", "type": "array", "required": false, "description": "需绑定的域名列表注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"example.com\"]", "item_type": "string" }, { "name": "IP", "type": "string", "required": false, "description": "需绑定的 IP 地址", "example": "0.0.0.0" } ] }, { "name": "DNSConfig", "type": "object", "required": false, "description": "DNS 配置注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Nameservers", "type": "array", "required": false, "description": "DNS IP 列表注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"0.0.0.0\"]", "item_type": "string" } ] } ] }, { "name": "Owner", "type": "string", "required": false, "description": "创建人名", "example": "owner-name" } ], "required": [ "Name", "Type", "ProjectId" ] }, { "name": "DeleteAlertChannel", "description": "删除告警通知接收组", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目 ID", "example": "project-xx" }, { "name": "NoticeId", "type": "string", "required": true, "description": "待删除的通知渠道的 Notice ID（所有通知渠道的 Notice ID 可以从 DescribeAlertChannels 接口获取）", "example": "notice-xx" } ], "required": [ "ProjectId", "NoticeId" ] }, { "name": "DeleteCronJobs", "description": "删除定时任务", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "CronJobIds", "type": "array", "required": true, "description": "定时任务ID数组", "example": "[\"cron-xx\"]", "item_type": "string" } ], "required": [ "ProjectId", "CronJobIds" ] }, { "name": "DeleteEnvironments", "description": "删除环境", "status": "online", "parameters": [], "required": [] }, { "name": "DeleteFiles", "description": "删除文件", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目 ID", "example": "project-hxmdlc3c" }, { "name": "FileIds", "type": "array", "required": true, "description": "待删除的文件的 ID（所有文件 ID 可从接口 DescribeFiles 获取）", "example": "[\"file-4og13yd4\"]", "item_type": "string" } ], "required": [ "ProjectId", "FileIds" ] }, { "name": "DeleteJobs", "description": "删除任务", "status": "online", "parameters": [ { "name": "JobIds", "type": "array", "required": true, "description": "待删除的任务的 ID（所有任务的 ID 可以从 DescribeJobs 获取）", "example": "[\"job-xx\"]", "item_type": "string" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "ScenarioIds", "type": "array", "required": true, "description": "场景ID数组", "example": "[\"scenario-xx\"]", "item_type": "string" } ], "required": [ "JobIds", "ProjectId", "ScenarioIds" ] }, { "name": "DeleteProjects", "description": "删除项目", "status": "online", "parameters": [ { "name": "ProjectIds", "type": "array", "required": true, "description": "项目ID数组", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "DeleteScenarios", "type": "boolean", "required": false, "description": "是否删除项目相关的场景。默认为否。", "example": "true" }, { "name": "DeleteJobs", "type": "boolean", "required": false, "description": "是否删除项目相关的任务。默认为否。", "example": "true" } ], "required": [ "ProjectIds" ] }, { "name": "DeleteScenarios", "description": "删除场景", "status": "online", "parameters": [ { "name": "ScenarioIds", "type": "array", "required": true, "description": "场景ID数组", "example": "[\"scenario-xx\"]", "item_type": "string" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "DeleteJobs", "type": "boolean", "required": false, "description": "是否删除场景相关的任务。默认为否。", "example": "true" } ], "required": [ "ScenarioIds", "ProjectId" ] }, { "name": "DescribeAlertChannels", "description": "查询告警通知接收组", "status": "online", "parameters": [ { "name": "ProjectIds", "type": "array", "required": true, "description": "项目 ID 列表", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大为100", "example": "10" }, { "name": "NoticeIds", "type": "array", "required": false, "description": "Notice ID 列表", "example": "[\"notice-xx\"]", "item_type": "string" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序项", "example": "CreatedAt" }, { "name": "Ascend", "type": "boolean", "required": false, "description": "是否正序", "example": "true" } ], "required": [ "ProjectIds" ] }, { "name": "DescribeAlertRecords", "description": "返回告警历史项的列表", "status": "online", "parameters": [ { "name": "ProjectIds", "type": "array", "required": true, "description": "项目 ID 列表", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "ScenarioIds", "type": "array", "required": false, "description": "场景 ID 列表", "example": "[\"scenario-xx\"]", "item_type": "string" }, { "name": "JobIds", "type": "array", "required": false, "description": "任务 ID 列表", "example": "[\"job-xx\"]", "item_type": "string" }, { "name": "Ascend", "type": "boolean", "required": false, "description": "是否正序", "example": "true" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序项", "example": "CreatedAt" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大为100", "example": "10" }, { "name": "ScenarioNames", "type": "array", "required": false, "description": "按场景名筛选", "example": "[\"my-scenario\"]", "item_type": "string" } ], "required": [ "ProjectIds" ] }, { "name": "DescribeAvailableMetrics", "description": "查询系统支持的指标", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCheckSummary", "description": "查询检查点汇总信息", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务ID", "example": "job-1a2b3c4d" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-1a2b3c4d" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-1a2b3c4d" } ], "required": [ "JobId", "ScenarioId", "ProjectId" ] }, { "name": "DescribeCronJobs", "description": "列出定时任务，非必填数组为空就默认全选", "status": "online", "parameters": [ { "name": "ProjectIds", "type": "array", "required": true, "description": "项目ID数组", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "10" }, { "name": "CronJobIds", "type": "array", "required": false, "description": "定时任务ID数组", "example": "[\"cron-xx\"]", "item_type": "string" }, { "name": "CronJobName", "type": "string", "required": false, "description": "定时任务名字，模糊查询", "example": "cron-name" }, { "name": "CronJobStatus", "type": "array", "required": false, "description": "定时任务状态数组", "example": "[1,2]", "item_type": "integer" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序的列", "example": "status" }, { "name": "Ascend", "type": "boolean", "required": false, "description": "是否正序", "example": "true" } ], "required": [ "ProjectIds" ] }, { "name": "DescribeEnvironments", "description": "查看环境列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeErrorSummary", "description": "查询错误详情汇总信息", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务ID", "example": "job-1a2b3c4d" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-1a2b3c4d" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-1a2b3c4d" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": "无", "item_type": "object", "children": [ { "name": "Operator", "type": "integer", "required": true, "description": "等于：0，不等于：1", "example": "0" }, { "name": "LabelName", "type": "string", "required": true, "description": "标签名，可选值包括： 1. method，请求方法名； 2. proto：协议名； 3. service：服务名； 4. status：响应状态码； 5. result：响应详情； 6. check：检查名。", "example": "service" }, { "name": "LabelValue", "type": "string", "required": true, "description": "标签值： 1. method：请求方法名，以 http 协议为例，method 为 GET、POST、PUT 等； 2. proto：协议名，以 http 协议为例，proto 为 HTTP/1.1、HTTP/2 等； 3. service：服务名，以 http 协议为例，service 为请求 url，如 http://httpbin.org/get 等； 4. status：响应状态码，以 http 协议为例，状态码包括 200、404、500 等； 5. result：响应详情，通过 result 判断请求成功或失败；请求正常，result 标签值为 ok；请\ufffd\ufffd...", "example": "www.baidu.com" } ] } ], "required": [ "JobId", "ScenarioId", "ProjectId" ] }, { "name": "DescribeFiles", "description": "查询文件列表", "status": "online", "parameters": [ { "name": "ProjectIds", "type": "array", "required": true, "description": "项目 ID 数组", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "FileIds", "type": "array", "required": false, "description": "文件 ID 数组", "example": "[\"file-xx\"]", "item_type": "string" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名", "example": "uin.csv" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大为 100", "example": "10" }, { "name": "Kind", "type": "integer", "required": false, "description": "文件种类，参数文件-1，协议文件-2，请求文件-3", "example": "1" } ], "required": [ "ProjectIds" ] }, { "name": "DescribeJobs", "description": "查询任务列表", "status": "online", "parameters": [ { "name": "ScenarioIds", "type": "array", "required": true, "description": "场景ID数组", "example": "[\"scenario-xx\"]", "item_type": "string" }, { "name": "ProjectIds", "type": "array", "required": true, "description": "项目ID数组", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页起始位置", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页最大数目", "example": "10" }, { "name": "JobIds", "type": "array", "required": false, "description": "任务ID数组", "example": "[\"job-xx\"]", "item_type": "string" }, { "name": "OrderBy", "type": "string", "required": false, "description": "按字段排序", "example": "id" }, { "name": "Ascend", "type": "boolean", "required": false, "description": "升序/降序", "example": "true" }, { "name": "StartTime", "type": "string", "required": false, "description": "任务开始时间", "example": "2021-09-08T16:08:50+08:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "任务结束时间", "example": "2021-09-08T16:08:50+08:00" }, { "name": "Debug", "type": "boolean", "required": false, "description": "调试任务标记", "example": "false" }, { "name": "Status", "type": "array", "required": false, "description": "任务的状态", "example": "[10,11]", "item_type": "integer" } ], "required": [ "ScenarioIds", "ProjectIds" ] }, { "name": "DescribeLabelValues", "description": "查询标签内容", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务ID", "example": "job-1a2b3c4d" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-1a2b3c4d" }, { "name": "Metric", "type": "string", "required": true, "description": "指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名", "example": "pts_engine_req_total" }, { "name": "LabelName", "type": "string", "required": true, "description": "标签名。取值范围参见 DescribeMetricLabelWithValues 接口返回的指标及其支持的标签名", "example": "service" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-1a2b3c4d" } ], "required": [ "JobId", "ScenarioId", "Metric", "LabelName", "ProjectId" ] }, { "name": "DescribeMetricLabelWithValues", "description": "查询指标所有的label及values值", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "job id", "example": "job-12345" }, { "name": "ProjectId", "type": "string", "required": true, "description": "project id", "example": "project-12345" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "scenario id", "example": "scenario-12345" } ], "required": [ "JobId", "ProjectId", "ScenarioId" ] }, { "name": "DescribeNormalLogs", "description": "压测过程日志包括引擎输出日志及用户输出日志", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "压测项目ID", "example": "project-xxx" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "测试场景ID", "example": "scenario-xxx" }, { "name": "JobId", "type": "string", "required": true, "description": "压测任务ID", "example": "job-xxxx" }, { "name": "Context", "type": "string", "required": false, "description": "日志上下文，加载更多日志时使用，透传上次返回的Context值，获取后续的日志内容。过期时间1小时", "example": "1234-5678" }, { "name": "From", "type": "string", "required": false, "description": "日志开始时间", "example": "2021-09-02T03:18:35+08:00" }, { "name": "To", "type": "string", "required": false, "description": "日志结束时间", "example": "2021-09-02T03:18:35+08:00" }, { "name": "SeverityText", "type": "string", "required": false, "description": "日志级别，可取debug/info/error", "example": "debug/info/error" }, { "name": "Instance", "type": "string", "required": false, "description": "施压节点IP", "example": "192.168.9.9" }, { "name": "InstanceRegion", "type": "string", "required": false, "description": "施压节点所在地域", "example": "ap-guangzhou/ap-shanghai" }, { "name": "LogType", "type": "string", "required": false, "description": "日志类型， console代表用户输出，engine代表引擎输出", "example": "console/engine" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回日志条数限制，最大100", "example": "50" } ], "required": [ "ProjectId", "ScenarioId", "JobId" ] }, { "name": "DescribeProjects", "description": "查询项目列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页offset", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页limit", "example": "10" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID数组", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "ProjectName", "type": "string", "required": false, "description": "项目名", "example": "project-xx" }, { "name": "OrderBy", "type": "string", "required": false, "description": "按字段排序", "example": "id" }, { "name": "Ascend", "type": "boolean", "required": false, "description": "升序/降序", "example": "true" }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签数组", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "owner" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tom" } ] } ], "required": [] }, { "name": "DescribeRegions", "description": "查询地域列表", "status": "online", "parameters": [ { "name": "LoadType", "type": "integer", "required": false, "description": "通过该参数指定不同压测网络环境，在不同网络环境下，PTS可用的地域不一样", "example": "0: 公网压测可用地域， 1: VPC私有网络压测可用地域，2: DevCloud环境可用地域" } ], "required": [] }, { "name": "DescribeRequestSummary", "description": "查询请求汇总信息", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "压测任务ID", "example": "job-1a2b3c4d" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "压测场景ID", "example": "scenario-12345" }, { "name": "ProjectId", "type": "string", "required": true, "description": "压测项目ID", "example": "project-12345" } ], "required": [ "JobId", "ScenarioId", "ProjectId" ] }, { "name": "DescribeSampleBatchQuery", "description": "批量查询指标，返回固定时间点指标内容", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "压测任务的 ID", "example": "job-i39wgjys" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景的 ID", "example": "scenario-4og13yd4" }, { "name": "Queries", "type": "array", "required": true, "description": "查询指标数组", "example": "无", "item_type": "object", "children": [ { "name": "Metric", "type": "string", "required": true, "description": "指标名", "example": "pts_engine_req_total" }, { "name": "Aggregation", "type": "string", "required": true, "description": "聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge", "example": "Rate" }, { "name": "Labels", "type": "array", "required": false, "description": "deprecated, 请使用Filters", "example": "[{\"LabelName\":\"Method\", \"LabelValue\":\"GET\"}]", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": true, "description": "标签名", "example": "service" }, { "name": "LabelValue", "type": "string", "required": true, "description": "标签值", "example": "http://mockhttpbin.pts.svc.cluster.local/get" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "用标签过滤规则来过滤指标，规则中包含标签名 LabelName、标签值 LabelValue、操作符 Operator（0代表相等，1代表不等）", "example": "[{\"LabelName\":\"Method\",\"Operator\":0, \"LabelValue\":\"GET\"}]", "item_type": "object", "children": [ { "name": "Operator", "type": "integer", "required": true, "description": "等于：0，不等于：1", "example": "0" }, { "name": "LabelName", "type": "string", "required": true, "description": "标签名，可选值包括： 1. method，请求方法名； 2. proto：协议名； 3. service：服务名； 4. status：响应状态码； 5. result：响应详情； 6. check：检查名。", "example": "service" }, { "name": "LabelValue", "type": "string", "required": true, "description": "标签值： 1. method：请求方法名，以 http 协议为例，method 为 GET、POST、PUT 等； 2. proto：协议名，以 http 协议为例，proto 为 HTTP/1.1、HTTP/2 等； 3. service：服务名，以 http 协议为例，service 为请求 url，如 http://httpbin.org/get 等； 4. status：响应状态码，以 http 协议为例，状态码包括 200、404、500 等； 5. result：响应详情，通过 result 判断请求成功或失败；请求正常，result 标签值为 ok；请\ufffd\ufffd...", "example": "www.baidu.com" } ] }, { "name": "GroupBy", "type": "array", "required": false, "description": "指标分组", "example": "[\"status\"]", "item_type": "string" } ] }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目的 ID", "example": "project-hxmdlc3c" } ], "required": [ "JobId", "ScenarioId", "Queries", "ProjectId" ] }, { "name": "DescribeSampleLogs", "description": "查询采样日志", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "测试项目ID", "example": "project-xxx" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "测试场景ID", "example": "scenario-xxx" }, { "name": "JobId", "type": "string", "required": true, "description": "测试任务ID", "example": "job-xxxx" }, { "name": "Context", "type": "string", "required": false, "description": "加载更多日志时使用，透传上次返回的Context值，获取后续的日志内容。过期时间1小时，不与 Offset 参数同时使用", "example": "csdfeee-dsfll09ds-sdsf" }, { "name": "From", "type": "string", "required": false, "description": "日志开始时间", "example": "2021-09-02T03:18:35+08:00" }, { "name": "To", "type": "string", "required": false, "description": "日志结束时间", "example": "2021-09-02T03:18:35+08:00" }, { "name": "SeverityText", "type": "string", "required": false, "description": "日志级别debug,info,error", "example": "info" }, { "name": "InstanceRegion", "type": "string", "required": false, "description": "地域", "example": "ap-shanghai" }, { "name": "Instance", "type": "string", "required": false, "description": "施压引擎节点IP", "example": "192.168.0.1" }, { "name": "LogType", "type": "string", "required": false, "description": "request 代表采样日志,engine 代表引擎日志，console 代表用户打印日志", "example": "request/engine/console" }, { "name": "Offset", "type": "integer", "required": false, "description": "日志偏移量，不与Context 参数同时使用", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回日志条数，最大100", "example": "50" }, { "name": "ReactionTimeRange", "type": "object", "required": false, "description": "采样日志响应时间范围", "example": "无", "children": [ { "name": "Min", "type": "string", "required": false, "description": "最小响应时间，单位ms", "example": "10" }, { "name": "Max", "type": "string", "required": false, "description": "最大响应时间，单位ms", "example": "100" } ] }, { "name": "Status", "type": "string", "required": false, "description": "采样请求状态码", "example": "200" }, { "name": "Result", "type": "string", "required": false, "description": "采样请求结果码", "example": "ok" }, { "name": "Method", "type": "string", "required": false, "description": "采样请求方法", "example": "Get" }, { "name": "Service", "type": "string", "required": false, "description": "采样服务API", "example": "http://www.baidu.com" } ], "required": [ "ProjectId", "ScenarioId", "JobId" ] }, { "name": "DescribeSampleMatrixBatchQuery", "description": "批量查询指标矩阵", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务ID", "example": "job-12345" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-12345" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-12345" }, { "name": "Queries", "type": "array", "required": true, "description": "查询语句", "example": "无", "item_type": "object", "children": [ { "name": "Metric", "type": "string", "required": true, "description": "指标名", "example": "pts_engine_req_total" }, { "name": "Aggregation", "type": "string", "required": true, "description": "聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge", "example": "Rate" }, { "name": "Labels", "type": "array", "required": false, "description": "deprecated, 请使用Filters", "example": "[{\"LabelName\":\"Method\", \"LabelValue\":\"GET\"}]", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": true, "description": "标签名", "example": "service" }, { "name": "LabelValue", "type": "string", "required": true, "description": "标签值", "example": "http://mockhttpbin.pts.svc.cluster.local/get" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "用标签过滤规则来过滤指标，规则中包含标签名 LabelName、标签值 LabelValue、操作符 Operator（0代表相等，1代表不等）", "example": "[{\"LabelName\":\"Method\",\"Operator\":0, \"LabelValue\":\"GET\"}]", "item_type": "object", "children": [ { "name": "Operator", "type": "integer", "required": true, "description": "等于：0，不等于：1", "example": "0" }, { "name": "LabelName", "type": "string", "required": true, "description": "标签名，可选值包括： 1. method，请求方法名； 2. proto：协议名； 3. service：服务名； 4. status：响应状态码； 5. result：响应详情； 6. check：检查名。", "example": "service" }, { "name": "LabelValue", "type": "string", "required": true, "description": "标签值： 1. method：请求方法名，以 http 协议为例，method 为 GET、POST、PUT 等； 2. proto：协议名，以 http 协议为例，proto 为 HTTP/1.1、HTTP/2 等； 3. service：服务名，以 http 协议为例，service 为请求 url，如 http://httpbin.org/get 等； 4. status：响应状态码，以 http 协议为例，状态码包括 200、404、500 等； 5. result：响应详情，通过 result 判断请求成功或失败；请求正常，result 标签值为 ok；请\ufffd\ufffd...", "example": "www.baidu.com" } ] }, { "name": "GroupBy", "type": "array", "required": false, "description": "指标分组", "example": "[\"status\"]", "item_type": "string" } ] }, { "name": "MaxPoint", "type": "integer", "required": false, "description": "最多返回的数据点个数", "example": "500" } ], "required": [ "JobId", "ProjectId", "ScenarioId", "Queries" ] }, { "name": "DescribeSampleMatrixQuery", "description": "查询指标矩阵", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务ID", "example": "job-12345" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-12345" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-12345" }, { "name": "Metric", "type": "string", "required": true, "description": "指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名", "example": "pts_engine_req_total" }, { "name": "Aggregation", "type": "string", "required": true, "description": "聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge", "example": "Rate" }, { "name": "Filters", "type": "array", "required": false, "description": "用标签过滤规则来过滤指标，规则中包含标签名 LabelName、标签值 LabelValue、操作符 Operator（0代表相等，1代表不等）", "example": "无", "item_type": "object", "children": [ { "name": "Operator", "type": "integer", "required": true, "description": "等于：0，不等于：1", "example": "0" }, { "name": "LabelName", "type": "string", "required": true, "description": "标签名，可选值包括： 1. method，请求方法名； 2. proto：协议名； 3. service：服务名； 4. status：响应状态码； 5. result：响应详情； 6. check：检查名。", "example": "service" }, { "name": "LabelValue", "type": "string", "required": true, "description": "标签值： 1. method：请求方法名，以 http 协议为例，method 为 GET、POST、PUT 等； 2. proto：协议名，以 http 协议为例，proto 为 HTTP/1.1、HTTP/2 等； 3. service：服务名，以 http 协议为例，service 为请求 url，如 http://httpbin.org/get 等； 4. status：响应状态码，以 http 协议为例，状态码包括 200、404、500 等； 5. result：响应详情，通过 result 判断请求成功或失败；请求正常，result 标签值为 ok；请\ufffd\ufffd...", "example": "www.baidu.com" } ] }, { "name": "GroupBy", "type": "array", "required": false, "description": "分组；取值范围参见 DescribeMetricLabelWithValues 接口返回的指标及其支持的标签名", "example": "[\"service\", \"result\", \"status\"]", "item_type": "string" }, { "name": "MaxPoint", "type": "integer", "required": false, "description": "返回的最大数据点个数", "example": "500" } ], "required": [ "JobId", "ProjectId", "ScenarioId", "Metric", "Aggregation" ] }, { "name": "DescribeSampleQuery", "description": "查询指标，返回固定时间点指标内容", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "job id", "example": "job-1a2b3c4d" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景Id", "example": "scenario-1a2b3c4d" }, { "name": "Metric", "type": "string", "required": true, "description": "指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名", "example": "pts_engine_req_total" }, { "name": "Aggregation", "type": "string", "required": true, "description": "聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge", "example": "Rate" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-1a2b3c4d" }, { "name": "Labels", "type": "array", "required": false, "description": "标签过滤条件。各指标支持的标签参见 DescribeMetricLabelWithValues 接口返回的所有指标及其支持的标签", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": true, "description": "标签名", "example": "service" }, { "name": "LabelValue", "type": "string", "required": true, "description": "标签值", "example": "http://mockhttpbin.pts.svc.cluster.local/get" } ] } ], "required": [ "JobId", "ScenarioId", "Metric", "Aggregation", "ProjectId" ] }, { "name": "DescribeScenarioWithJobs", "description": "查询场景配置并附带已经执行的任务内容", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大为100", "example": "10" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID数组", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "ScenarioIds", "type": "array", "required": false, "description": "场景ID数组", "example": "[\"scenario-xx\"]", "item_type": "string" }, { "name": "ScenarioName", "type": "string", "required": false, "description": "场景名", "example": "scenario name" }, { "name": "ScenarioStatus", "type": "integer", "required": false, "description": "场景状态数组", "example": "[1,2]" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序的列", "example": "status" }, { "name": "Ascend", "type": "boolean", "required": false, "description": "是否正序", "example": "true/false" }, { "name": "ScenarioRelatedJobsParams", "type": "object", "required": false, "description": "job相关参数", "example": "无", "children": [ { "name": "Offset", "type": "integer", "required": false, "description": "job偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制最多查询的job数", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段", "example": "start_time" }, { "name": "Ascend", "type": "boolean", "required": false, "description": "是否升序", "example": "true/false" } ] }, { "name": "IgnoreScript", "type": "boolean", "required": false, "description": "是否需要返回场景的脚本内容", "example": "true" }, { "name": "IgnoreDataset", "type": "boolean", "required": false, "description": "是否需要返回测试数据文件信息", "example": "true" }, { "name": "ScenarioType", "type": "string", "required": false, "description": "场景类型，如pts-http, pts-js, pts-trpc, pts-jmeter", "example": "pts-xx" }, { "name": "Owner", "type": "string", "required": false, "description": "创建人员", "example": "owner" } ], "required": [] }, { "name": "DescribeScenarios", "description": "查询场景列表", "status": "online", "parameters": [ { "name": "ScenarioIds", "type": "array", "required": false, "description": "场景ID数组", "example": "[\"scenario-xx\"]", "item_type": "string" }, { "name": "ScenarioName", "type": "string", "required": false, "description": "场景名", "example": "scenario-name" }, { "name": "ScenarioStatus", "type": "array", "required": false, "description": "场景状态数组", "example": "[1,2]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大为100", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序的列", "example": "status" }, { "name": "Ascend", "type": "boolean", "required": false, "description": "是否正序", "example": "true" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID数组", "example": "[\"project-xx\"]", "item_type": "string" }, { "name": "ScenarioType", "type": "string", "required": false, "description": "场景类型", "example": "pts-js" } ], "required": [] }, { "name": "GenerateTmpKey", "description": "生成临时COS凭证", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "ScenarioId", "type": "string", "required": false, "description": "场景ID", "example": "scenario-xx" } ], "required": [ "ProjectId" ] }, { "name": "RestartCronJobs", "description": "重启状态为已中止的定时任务", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "CronJobIds", "type": "array", "required": true, "description": "定时任务ID数组", "example": "[\"cron-xx\"]", "item_type": "string" } ], "required": [ "ProjectId", "CronJobIds" ] }, { "name": "StartJob", "description": "创建并启动任务", "status": "online", "parameters": [ { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-xx" }, { "name": "JobOwner", "type": "string", "required": true, "description": "任务发起人", "example": "tom" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "Debug", "type": "boolean", "required": false, "description": "是否调试", "example": "true" }, { "name": "Note", "type": "string", "required": false, "description": "备注", "example": "备注" } ], "required": [ "ScenarioId", "JobOwner", "ProjectId" ] }, { "name": "UpdateCronJob", "description": "更新定时任务", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "CronJobId", "type": "string", "required": true, "description": "定时任务ID", "example": "cron-xx" }, { "name": "Note", "type": "string", "required": true, "description": "备注", "example": "备注" }, { "name": "CronExpression", "type": "string", "required": true, "description": "cron表达式", "example": "*/1 * * * *" }, { "name": "FrequencyType", "type": "integer", "required": true, "description": "执行频率类型，1:只执行一次; 2:日粒度; 3:周粒度; 4:高级", "example": "1" }, { "name": "Name", "type": "string", "required": true, "description": "定时任务名字", "example": "cronjob" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-xx" }, { "name": "ScenarioName", "type": "string", "required": true, "description": "场景名称", "example": "scenario name" }, { "name": "JobOwner", "type": "string", "required": true, "description": "任务发起人", "example": "tom" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2014-08-03T12:00:00+08:00" }, { "name": "NoticeId", "type": "string", "required": false, "description": "Notice ID", "example": "notice-xx" } ], "required": [ "ProjectId", "CronJobId", "Note", "CronExpression", "FrequencyType", "Name", "ScenarioId", "ScenarioName", "JobOwner" ] }, { "name": "UpdateEnvironment", "description": "更新环境", "status": "online", "parameters": [], "required": [] }, { "name": "UpdateFileScenarioRelation", "description": "更新关联文件场景", "status": "online", "parameters": [ { "name": "FileId", "type": "string", "required": true, "description": "文件 ID。其值应为前序步骤上传该文件到 cos 桶后，文件在 cos 桶中的相应目录", "example": "file-03874f00" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目 ID", "example": "project-btksohr0" }, { "name": "ScenarioIds", "type": "array", "required": false, "description": "场景 ID 数组", "example": "[\"scenario-j1u85ixm\"]", "item_type": "string" } ], "required": [ "FileId", "ProjectId" ] }, { "name": "UpdateJob", "description": "更新任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务ID", "example": "job-xx" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-xx" }, { "name": "Note", "type": "string", "required": false, "description": "任务备注信息", "example": "this is a test job" } ], "required": [ "JobId", "ProjectId", "ScenarioId" ] }, { "name": "UpdateProject", "description": "更新项目", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "project-xx" }, { "name": "Name", "type": "string", "required": false, "description": "项目名", "example": "project name" }, { "name": "Description", "type": "string", "required": false, "description": "项目描述", "example": "this is a test project" }, { "name": "Status", "type": "integer", "required": false, "description": "项目状态，默认传递1", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签数组", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "owner" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tom" } ] } ], "required": [ "ProjectId" ] }, { "name": "UpdateScenario", "description": "更新场景", "status": "online", "parameters": [ { "name": "ScenarioId", "type": "string", "required": true, "description": "场景ID", "example": "scenario-1a2b3c4d" }, { "name": "Name", "type": "string", "required": false, "description": "场景名；调用该接口时，请将 Scenario 中不需要修改的字段保持原样也作为接口的入参，否则场景可能会不可用。", "example": "scenario name" }, { "name": "Description", "type": "string", "required": false, "description": "场景描述", "example": "this is a test scenario" }, { "name": "Type", "type": "string", "required": false, "description": "压测场景的模式类型。取值范围：pts-http 代表简单模式，pts-js 代表脚本模式，pts-jmeter 代表 JMeter 模式。", "example": "pts-http" }, { "name": "Load", "type": "object", "required": false, "description": "施压配置", "example": "无", "children": [ { "name": "LoadSpec", "type": "object", "required": false, "description": "施压配置", "example": "无", "children": [ { "name": "Concurrency", "type": "object", "required": false, "description": "并发施压模式的配置注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Stages", "type": "array", "required": false, "description": "多阶段配置数组注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "IterationCount", "type": "integer", "required": false, "description": "运行次数", "example": "10" }, { "name": "MaxRequestsPerSecond", "type": "integer", "required": false, "description": "最大RPS", "example": "1000" }, { "name": "GracefulStopSeconds", "type": "integer", "required": false, "description": "优雅终止任务的等待时间", "example": "3" }, { "name": "Resources", "type": "integer", "required": false, "description": "资源数", "example": "6" }, { "name": "Mode", "type": "string", "required": false, "description": "压力模型", "example": "不填代表梯度递增，spike: 浪涌模式，step: 梯度递增" } ] }, { "name": "RequestsPerSecond", "type": "object", "required": false, "description": "RPS施压模式的配置注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "MaxRequestsPerSecond", "type": "integer", "required": false, "description": "最大RPS", "example": "1000" }, { "name": "DurationSeconds", "type": "integer", "required": false, "description": "施压时间", "example": "60" }, { "name": "TargetVirtualUsers", "type": "integer", "required": false, "description": "deprecated", "example": "30" }, { "name": "Resources", "type": "integer", "required": false, "description": "资源数", "example": "6" }, { "name": "StartRequestsPerSecond", "type": "integer", "required": false, "description": "起始RPS", "example": "500" }, { "name": "TargetRequestsPerSecond", "type": "integer", "required": false, "description": "目标RPS，入参无效", "example": "500" }, { "name": "GracefulStopSeconds", "type": "integer", "required": false, "description": "优雅关停的等待时间", "example": "3" }, { "name": "IterationCount", "type": "integer", "required": false, "description": "场景最大执行次数", "example": "1000" } ] }, { "name": "ScriptOrigin", "type": "object", "required": false, "description": "脚本内置压力模式注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "MachineNumber", "type": "integer", "required": true, "description": "机器数量", "example": "10" }, { "name": "MachineSpecification", "type": "string", "required": true, "description": "机器规格", "example": "1c2g, 2c4g, 4g8g" }, { "name": "DurationSeconds", "type": "integer", "required": true, "description": "压测时长", "example": "1200" } ] } ] }, { "name": "VpcLoadDistribution", "type": "object", "required": false, "description": "压力来源注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "RegionId", "type": "integer", "required": true, "description": "地域ID", "example": "1" }, { "name": "Region", "type": "string", "required": false, "description": "地域", "example": "ap-guangzhou" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC ID", "example": "vpc-xx" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网ID列表注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"subnet-xxx\"]", "item_type": "string" } ] }, { "name": "GeoRegionsLoadDistribution", "type": "array", "required": false, "description": "多地域压力分布注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RegionId", "type": "integer", "required": true, "description": "地域ID", "example": "1" }, { "name": "Region", "type": "string", "required": false, "description": "地域", "example": "ap-guangzhou" }, { "name": "Percentage", "type": "integer", "required": false, "description": "百分比", "example": "50" } ] } ] }, { "name": "EncodedScripts", "type": "string", "required": false, "description": "deprecated", "example": "WyJhYmMiLCAiZGVmIl0K" }, { "name": "Configs", "type": "array", "required": false, "description": "deprecated", "example": "[\"a.prop\",\"b.prop\"]", "item_type": "string" }, { "name": "Datasets", "type": "array", "required": false, "description": "测试数据集", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "测试数据集所在的文件名", "example": "info.csv" }, { "name": "Split", "type": "boolean", "required": true, "description": "测试数据集是否分片", "example": "true" }, { "name": "HeaderInFile", "type": "boolean", "required": true, "description": "首行是否为参数名", "example": "true" }, { "name": "HeaderColumns", "type": "array", "required": false, "description": "参数名数组注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"name\", \"age\"]", "item_type": "string" }, { "name": "LineCount", "type": "integer", "required": false, "description": "文件行数", "example": "10" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "Size", "type": "integer", "required": false, "description": "文件字节数", "example": "10" }, { "name": "HeadLines", "type": "array", "required": false, "description": "头部数据行注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"head-line-value\"]", "item_type": "string" }, { "name": "TailLines", "type": "array", "required": false, "description": "尾部数据行注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"tail-line-value\"]", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "CSV" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] }, { "name": "Extensions", "type": "array", "required": false, "description": "deprecated", "example": "[\"a.jar\",\"b.jar\"]", "item_type": "string" }, { "name": "SLAId", "type": "string", "required": false, "description": "SLA规则ID", "example": "sla-1a2b3c4d" }, { "name": "CronId", "type": "string", "required": false, "description": "cron job ID", "example": "cron-1a2b3c4d" }, { "name": "Status", "type": "integer", "required": false, "description": "场景状态（注：现已无需传递该参数）", "example": "2" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID", "example": "project-1a2b3c4d" }, { "name": "TestScripts", "type": "array", "required": false, "description": "测试脚本路径", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "文件名", "example": "hello.js" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "js" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "EncodedContent", "type": "string", "required": false, "description": "base64编码后的文件内容", "example": "sfadsfdsfdfdfsfdsgerdf" }, { "name": "EncodedHttpArchive", "type": "string", "required": false, "description": "base64编码后的har结构体", "example": "sfadsfdsfdfdfsfdsgerdf" }, { "name": "LoadWeight", "type": "integer", "required": false, "description": "脚本权重，范围 1-100", "example": "100" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xxx" }, { "name": "Uploaded", "type": "boolean", "required": false, "description": "文件是否已上传，如果已上传，则可以不必填写 EncodedContent,EncodedHar 等内容。主要用于较大长度脚本上传。", "example": "true/false" } ] }, { "name": "Protocols", "type": "array", "required": false, "description": "协议文件路径", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "协议详情", "example": "hello.proto" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "proto" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] }, { "name": "RequestFiles", "type": "array", "required": false, "description": "请求文件路径", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "文件名", "example": "a.log" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "csv" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] }, { "name": "SLAPolicy", "type": "object", "required": false, "description": "SLA 策略", "example": "无", "children": [ { "name": "SLARules", "type": "array", "required": false, "description": "SLA 规则注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Metric", "type": "string", "required": false, "description": "压测指标", "example": "pts_engine_req_total" }, { "name": "Aggregation", "type": "string", "required": false, "description": "压测指标聚合方法", "example": "avg" }, { "name": "Condition", "type": "string", "required": false, "description": "压测指标条件判断符号", "example": "\u003e" }, { "name": "Value", "type": "float", "required": false, "description": "阈值", "example": "1.00" }, { "name": "LabelFilter", "type": "array", "required": false, "description": "标签注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "标签名", "example": "service" }, { "name": "LabelValue", "type": "string", "required": false, "description": "标签值", "example": "http://httpbin.org/get" } ] }, { "name": "AbortFlag", "type": "boolean", "required": false, "description": "是否停止压测任务", "example": "true" }, { "name": "For", "type": "string", "required": false, "description": "持续时长", "example": "1m" } ] }, { "name": "AlertChannel", "type": "object", "required": false, "description": "告警通知渠道注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "NoticeId", "type": "string", "required": false, "description": "通知模板ID", "example": "notice-xx" }, { "name": "AMPConsumerId", "type": "string", "required": false, "description": "AMP consumer ID", "example": "consumer-xx" } ] } ] }, { "name": "Plugins", "type": "array", "required": false, "description": "拓展包文件路径", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "文件名", "example": "a.log" }, { "name": "Size", "type": "integer", "required": false, "description": "文件大小", "example": "100" }, { "name": "Type", "type": "string", "required": false, "description": "文件类型", "example": "csv" }, { "name": "UpdatedAt", "type": "string", "required": false, "description": "更新时间注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-09-02T03:18:35+08:00" }, { "name": "FileId", "type": "string", "required": false, "description": "文件 ID", "example": "file-xx" } ] }, { "name": "DomainNameConfig", "type": "object", "required": false, "description": "域名解析配置", "example": "无", "children": [ { "name": "HostAliases", "type": "array", "required": false, "description": "域名绑定配置注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HostNames", "type": "array", "required": false, "description": "需绑定的域名列表注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"example.com\"]", "item_type": "string" }, { "name": "IP", "type": "string", "required": false, "description": "需绑定的 IP 地址", "example": "0.0.0.0" } ] }, { "name": "DNSConfig", "type": "object", "required": false, "description": "DNS 配置注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Nameservers", "type": "array", "required": false, "description": "DNS IP 列表注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"0.0.0.0\"]", "item_type": "string" } ] } ] }, { "name": "NotificationHooks", "type": "array", "required": false, "description": "WebHook请求配置", "example": "无", "item_type": "object", "children": [ { "name": "Events", "type": "array", "required": false, "description": "发生事件", "example": "[\"name\", \"age\"]", "item_type": "string" }, { "name": "URL", "type": "string", "required": false, "description": "webhook的网址", "example": "\"http://abc.com\"" } ] }, { "name": "Owner", "type": "string", "required": false, "description": "创建人名", "example": "owner-name" }, { "name": "EnvId", "type": "string", "required": false, "description": "环境ID", "example": "env-1a2b3c4d" } ], "required": [ "ScenarioId" ] } ] }