文档首页/ 性能测试 CodeArts PerfTest/ API参考/ API/ 全链路压测管理/ 全链路压测探针获取配置信息
更新时间：2024-11-28 GMT+08:00
查看PDF
分享

全链路压测探针获取配置信息

功能介绍

全链路压测探针获取配置信息

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/stress/agents

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

app_id

是

Integer

应用ID

address

是

String

探针的内网地址

version

是

String

探针的版本

agent_id

否

String

探针ID，非必填，不填是注册探针，填了是更新探针配置

alias

否

String

探针别名

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

message

String

响应消息

extend

Object

扩展信息

result

AgentConfig object

结果
表4 AgentConfig

参数

参数类型

描述

agent_id

Integer

探针ID

db_enable

Boolean

是否开启数据库影子规则

db_shadow_repository

String

数据库影子库名称

db_shadow_type

String

数据库影子库类型

log_level

String

日志级别，枚举值：INFO，DEBUG，WARN，ERROR

log_path

String

日志路径

main_switch

Boolean

影子规则开关

redis_enable

Boolean

是否开启redis影子库规则

redis_shadow_key_prefix

String

redis影子库key前缀

redis_shadow_repository

String

redis影子库名称

redis_shadow_type

String

redis影子库类型

kafka_enable

Boolean

kafka影子规则开关

kafka_shadow_topic_prefix

String

kafka影子topic前缀

app_log_level

String

应用日志等级（ALL/TRACE/DEBUG/INFO/WARN/ERROR/OFF）

app_log_path

String

应用日志路径

mock_rule_list

Array of MockRuleConfig objects

mock规则列表

clickhouse_enable

Boolean

clickhouse影子规则开关

clickhouse_shadow_type

String

clickhouse影子规则类型

clickhouse_shadow_repository

String

clickhouse影子库映射信息

pulsar_enable

Boolean

是否开启pulsar影子库规则

pulsar_shadow_topic_prefix

String

pulsar影子库前缀

extensions

String

自定义配置
表5 MockRuleConfig

参数

参数类型

描述

service_type

String

服务类型（当前只支持http）

request_url

String

请求地址

request_method

String

请求方式（GET/POST/PUT/DELET/PATCH）

redirect_url

String

重定向地址

mock_strategy

String

mock策略（redirect/json）

enable

Boolean

是否启用

name

String

规则名称

project_id

String

项目ID

id

Integer

规则ID

response_header

Map<String,String>

自定义响应头

response_body

String

自定义响应体

response_time

Integer

自定义响应时长

response_code

Integer

自定义响应码

请求示例

查询全链路压测探针配置信息，应用的id是1。

/v1/{project_id}/stress/agents

{
  "app_id" : 1,
  "address" : "192.168.1.1",
  "version" : "0.3.2"
}

响应示例

无

状态码

状态码

描述

200

获取探针配置响应

错误码

请参见错误码。

父主题： 全链路压测管理

相关文档