tencent cloud

APIs

文档APIsApplication Performance ManagementData Types

数据结构

Download
聚焦模式
字号
最后更新时间： 2026-05-14 20:28:59

APMKV

APM 浮点数类型键值对

被如下接口引用：DescribeApmAllVulCount, DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeApmVulnerabilityCount, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview。

名称 类型 必选 描述
Key String 否 Key 值定义
Value Float 否 Value 值定义

APMKVItem

APM 通用 KV 结构

被如下接口引用：CreateApmSampleConfig, DescribeApmAllVulCount, DescribeApmSQLInjectionDetail, DescribeApmSampleConfig, DescribeApmServiceMetric, DescribeApmVulnerabilityCount, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview, ModifyApmSampleConfig。

名称 类型 必选 描述
Key String 是 Key 值定义
Value String 是 Value 值定义

AgentOperationConfigView

探针有关接口的相关配置

被如下接口引用：DescribeApmApplicationConfig, ModifyApmApplicationConfig。

名称 类型 必选 描述
RetentionValid Boolean 否 当前接口配置是否开启了接口白名单配置
注意：此字段可能返回 null，表示取不到有效值。
IgnoreOperation String 否 RetentionValid为false时生效，接口配置中的黑名单配置，配置中的接口不采集
注意：此字段可能返回 null，表示取不到有效值。
RetentionOperation String 否 RetentionValid为true时生效，接口配置中的白名单配置，仅采集配置中的接口
注意：此字段可能返回 null，表示取不到有效值。

ApmAgentInfo

APM Agent 信息

被如下接口引用：DescribeApmAgent。

名称 类型 描述
AgentDownloadURL String Agent 下载地址
CollectorURL String Collector 上报地址
Token String Token 信息
PublicCollectorURL String 外网上报地址
InnerCollectorURL String 自研 VPC 上报地址
PrivateLinkCollectorURL String 内网上报地址( Private Link 上报地址)

ApmAppConfig

查询应用配置返回参数

被如下接口引用：DescribeApmApplicationConfig。

名称 类型 描述
InstanceKey String

实例ID
ServiceName String

服务名
UrlConvergenceSwitch Integer

URL收敛开关
UrlConvergenceThreshold Integer

URL收敛阈值
UrlConvergence String

URL收敛正则
ExceptionFilter String

异常过滤正则
ErrorCodeFilter String

错误码过滤
Components String

服务组件类型
UrlExclude String

URL排除正则
LogSource String

日志来源
LogRegion String

日志所在地域
IsRelatedLog Integer

是否开启日志 0 关 1 开
LogTopicID String

日志主题ID
IgnoreOperationName String

需过滤的接口名
LogSet String

CLS日志集
TraceRateLimit Integer

探针每秒上报trace数
EnableSnapshot Boolean

是否开启线程剖析
SnapshotTimeout Integer

线程剖析超时阈值
AgentEnable Boolean

是否开启agent
InstrumentList Array of Instrument

组件列表


注意：此字段可能返回 null，表示取不到有效值。
TraceSquash Boolean

是否开启链路压缩
EventEnable Boolean

是否开启应用诊断开关
AgentOperationConfigView AgentOperationConfigView

探针接口相关配置


注意：此字段可能返回 null，表示取不到有效值。
EnableLogConfig Boolean

是否开启应用日志配置
ServiceID String

应用ID


注意：此字段可能返回 null，表示取不到有效值。
EnableDashboardConfig Boolean

应用是否开启dashboard配置： false 关（与业务系统保持一致）/true 开（应用级配置）


注意：此字段可能返回 null，表示取不到有效值。
IsRelatedDashboard Integer

是否关联dashboard： 0 关 1 开


注意：此字段可能返回 null，表示取不到有效值。
DashboardTopicID String

dashboard ID


注意：此字段可能返回 null，表示取不到有效值。
EnableSecurityConfig Boolean

是否开启应用级别配置


注意：此字段可能返回 null，表示取不到有效值。
IsInstrumentationVulnerabilityScan Integer

是否开启组件漏洞检测


注意：此字段可能返回 null，表示取不到有效值。
IsSqlInjectionAnalysis Integer

是否开启SQL注入分析


注意：此字段可能返回 null，表示取不到有效值。
IsRemoteCommandExecutionAnalysis Integer

是否开启远程命令执行分析


注意：此字段可能返回 null，表示取不到有效值。
IsMemoryHijackingAnalysis Integer

是否开启内存马检测分析


注意：此字段可能返回 null，表示取不到有效值。
LogIndexType Integer

CLS索引类型(0=全文索引，1=键值索引)
LogTraceIdKey String

traceId的索引key: 当CLS索引类型为键值索引时生效
IsDeleteAnyFileAnalysis Integer

是否开启删除任意文件检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsReadAnyFileAnalysis Integer

是否开启读取任意文件检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsUploadAnyFileAnalysis Integer

是否开启上传任意文件检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsIncludeAnyFileAnalysis Integer

是否开启包含任意文件检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsDirectoryTraversalAnalysis Integer

是否开启目录遍历检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsTemplateEngineInjectionAnalysis Integer

是否开启模板引擎注入检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsScriptEngineInjectionAnalysis Integer

是否开启脚本引擎注入检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsExpressionInjectionAnalysis Integer

是否开启表达式注入检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsJNDIInjectionAnalysis Integer

是否开启JNDI注入检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsJNIInjectionAnalysis Integer

是否开启JNI注入检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsWebshellBackdoorAnalysis Integer

是否开启Webshell后门检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
IsDeserializationAnalysis Integer

是否开启反序列化检测（0-关闭，1-开启）


注意：此字段可能返回 null，表示取不到有效值。
UrlAutoConvergenceEnable Boolean

接口名称自动收敛开关（0-关闭，1-开启）
UrlLongSegmentThreshold Integer

URL长分段收敛阈值
UrlNumberSegmentThreshold Integer

URL数字分段收敛阈值
DisableMemoryUsed Integer

探针熔断内存阈值
DisableCpuUsed Integer

探针熔断CPU阈值
DbStatementParametersEnabled Boolean

是否开启SQL参数获取
SlowSQLThresholds Array of ApmTag

慢SQL阈值
EnableDesensitizationRule Integer

是否开启脱敏规则
DesensitizationRule String

脱敏规则
LogSpanIdKey String

spanId的索引key: 当CLS索引类型为键值索引时生效
AutoProfilingConfig AutoProfilingConfig

自动性能剖析配置
EnableThresholdConfig Boolean

阈值配置开关。true 表示使用应用级阈值；false 表示使用业务系统级阈值
ErrRateThreshold Integer

错误率阈值（%），用于判断应用健康状态为"红色"
ResponseDurationWarningThreshold Integer

响应时间预警阈值（ms），用于判断应用健康状态为"黄色"
UseDefaultFuseConfig Boolean

是否默认使用探针自带熔断阈值

ApmApplicationConfigView

应用相关的配置列表项

被如下接口引用：DescribeGeneralApmApplicationConfig。

名称 类型 必选 描述
InstanceKey String 否

业务系统 ID
ServiceName String 否

应用名
OperationNameFilter String 否

接口过滤
ExceptionFilter String 否

错误类型过滤
ErrorCodeFilter String 否

HTTP 状态码过滤
EventEnable Boolean 否

应用诊断开关（已废弃）
UrlConvergenceSwitch Integer 否

URL 收敛开关 0 关 1 开
UrlConvergenceThreshold Integer 否

URL 收敛阈值
UrlConvergence String 否

URL 收敛规则正则
UrlExclude String 否

URL 排除规则正则
IsRelatedLog Integer 否

是否开启日志 0 关 1 开
LogSource String 否

日志源
LogSet String 否

日志集
LogTopicID String 否

日志主题
SnapshotEnable Boolean 否

方法栈快照开关 true 开启 false 关闭
SnapshotTimeout Integer 否

慢调用监听触发阈值
AgentEnable Boolean 否

探针总开关
InstrumentList Array of Instrument 否

组件列表开关（已废弃）
TraceSquash Boolean 否

链路压缩开关（已废弃）
AgentIgnoreOperation String 否

链路过滤配置
EnableSecurityConfig Boolean 否

开启应用安全开关
IsSqlInjectionAnalysis Integer 否

是否开启SQL注入检测
IsInstrumentationVulnerabilityScan Integer 否

是否开启组件漏洞检测
IsRemoteCommandExecutionAnalysis Integer 否

是否开启远程命令执行检测
IsMemoryHijackingAnalysis Integer 否

是否开启内存泄漏检测
IsDeleteAnyFileAnalysis Integer 否

是否开启删除任意文件检测
IsReadAnyFileAnalysis Integer 否

是否开启读取任意文件检测
IsUploadAnyFileAnalysis Integer 否

是否开启上传任意文件检测
IsIncludeAnyFileAnalysis Integer 否

是否开启包含任意文件检测
IsDirectoryTraversalAnalysis Integer 否

是否开启目录遍历检测
IsTemplateEngineInjectionAnalysis Integer 否

是否开启模板引擎注入检测
IsScriptEngineInjectionAnalysis Integer 否

是否开启脚本引擎注入检测
IsExpressionInjectionAnalysis Integer 否

是否开启表达式注入检测
IsJndiInjectionAnalysis Integer 否

是否开启JNDI注入检测
IsJniInjectionAnalysis Integer 否

是否开启JNI注入检测
IsWebshellBackdoorAnalysis Integer 否

是否开启Webshell后门检测
IsDeserializationAnalysis Integer 否

是否开启反序列化检测
EnableDashboardConfig Boolean 否

是否开启控制台开关
IsRelatedDashboard Integer 否

是否关联Dashboard
DashboardTopicID String 否

Dashboard topic
DisableMemoryUsed Integer 否

探针熔断内存阈值
DisableCpuUsed Integer 否

探针熔断CPU阈值
DbStatementParametersEnabled Boolean 否

是否开启SQL参数获取
SlowSQLThresholds Array of ApmTag 否

慢SQL阈值
EnableDesensitizationRule Integer 否

是否开启脱敏规则
DesensitizationRule String 否

脱敏规则
AutoProfilingConfig AutoProfilingConfig 否

自动性能剖析任务配置
EnableThresholdConfig Boolean 否

阈值配置开关
ErrRateThreshold Integer 否

错误率阈值

单位：%
ResponseDurationWarningThreshold Integer 否

响应时间预警阈值

单位：ms
UseDefaultFuseConfig Boolean 否

是否使用探针默认熔断阈值

ApmAssociation

展示apm业务系统与其他云产品关联关系返回体

被如下接口引用：DescribeApmAssociation。

名称 类型 描述
PeerId String

关联产品的实例ID


注意：此字段可能返回 null，表示取不到有效值。
Status Integer

关联关系状态：1（启用）、2（不启用）、3（已失效）


注意：此字段可能返回 null，表示取不到有效值。
Topic String

CKafka消息主题
MetricTopic String

Ckafka消费主题

用于Kafka指标投递

ApmField

指标维度信息

被如下接口引用：DescribeApmAllVulCount, DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeApmVulnerabilityCount, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview。

名称 类型 描述
Key String 指标名
Value Float 指标数值
Unit String 指标所对应的单位
CompareVals Array of APMKVItem 同比结果数组，推荐使用
注意：此字段可能返回 null，表示取不到有效值。
LastPeriodValue Array of APMKV 同比上一个周期的具体指标数值
注意：此字段可能返回 null，表示取不到有效值。
CompareVal String 同比指标值，已弃用，不建议使用
NameCN String 指标中文名
NameEN String 指标英文名

ApmInstanceDetail

APM 业务系统信息

被如下接口引用：DescribeApmInstances。

名称 类型 描述
InstanceId String 业务系统 ID
Name String 业务系统名
Description String 业务系统描述信息
Status Integer 业务系统状态。{
1: 初始化中; 2: 运行中; 4: 限流}
Region String 业务系统所属地域
Tags Array of ApmTag 业务系统 Tag 列表
AppId Integer AppID 信息
CreateUin String 创建人 Uin
AmountOfUsedStorage Float 存储使用量(单位：MB)
ServiceCount Integer 该业务系统服务端应用数量
CountOfReportSpanPerDay Integer 日均上报 Span 数
TraceDuration Integer Trace 数据保存时长（单位：天）
SpanDailyCounters Integer 业务系统上报额度
BillingInstance Integer 业务系统是否已开通计费（0=未开通，1=已开通）
ErrRateThreshold Integer 错误警示线（单位：%）
SampleRate Integer 采样率（单位：%）
ErrorSample Integer 是否开启错误采样（0=关, 1=开）
SlowRequestSavedThreshold Integer 采样慢调用保存阈值（单位：ms）
LogRegion String CLS 日志所在地域
LogSource String 日志源
IsRelatedLog Integer 日志功能开关（0=关， 1=开）
LogTopicID String 日志主题 ID
ClientCount Integer 该业务系统客户端应用数量
TotalCount Integer 该业务系统最近2天活跃应用数量
LogSet String CLS 日志集
MetricDuration Integer Metric 数据保存时长（单位：天）
CustomShowTags Array of String 用户自定义展示标签列表
PayMode Integer 业务系统计费模式（1为预付费，0为按量付费）
PayModeEffective Boolean 业务系统计费模式是否生效
ResponseDurationWarningThreshold Integer 响应时间警示线（单位：ms）
Free Integer 是否免费（0=否，1=限额免费，2=完全免费），默认0
DefaultTSF Integer 是否 TSF 默认业务系统（0=否，1=是）
IsRelatedDashboard Integer 是否关联 Dashboard（0=关, 1=开）
DashboardTopicID String 关联的 Dashboard ID
IsInstrumentationVulnerabilityScan Integer 是否开启组件漏洞检测（0=关， 1=开）
IsSqlInjectionAnalysis Integer 是否开启 SQL 注入分析（0=关， 1=开）
StopReason Integer 限流原因。{
1: 正式版限额;
2: 试用版限额;
4: 试用版到期;
8: 账号欠费
}
IsRemoteCommandExecutionAnalysis Integer 是否开远程命令执行检测（0=关， 1=开）
IsMemoryHijackingAnalysis Integer 是否开内存马执行检测（0=关， 1=开）
LogIndexType Integer CLS索引类型(0=全文索引，1=键值索引)
LogTraceIdKey String traceId的索引key: 当CLS索引类型为键值索引时生效
IsDeleteAnyFileAnalysis Integer 是否开启删除任意文件检测（0-关闭，1-开启）
IsReadAnyFileAnalysis Integer 是否开启读取任意文件检测（0-关闭，1-开启）
IsUploadAnyFileAnalysis Integer 是否开启上传任意文件检测（0-关闭，1-开启）
IsIncludeAnyFileAnalysis Integer 是否开启包含任意文件检测（0-关闭，1-开启）
IsDirectoryTraversalAnalysis Integer 是否开启目录遍历检测（0-关闭，1-开启）
IsTemplateEngineInjectionAnalysis Integer 是否开启模板引擎注入检测（0-关闭，1-开启）
IsScriptEngineInjectionAnalysis Integer 是否开启脚本引擎注入检测（0-关闭，1-开启）
IsExpressionInjectionAnalysis Integer 是否开启表达式注入检测（0-关闭，1-开启）
IsJNDIInjectionAnalysis Integer 是否开启JNDI注入检测（0-关闭，1-开启）
IsJNIInjectionAnalysis Integer 是否开启JNI注入检测（0-关闭，1-开启）
IsWebshellBackdoorAnalysis Integer 是否开启Webshell后门检测（0-关闭，1-开启）
IsDeserializationAnalysis Integer 是否开启反序列化检测（0-关闭，1-开启）
Token String 业务系统鉴权 token
UrlLongSegmentThreshold Integer URL长分段收敛阈值
UrlNumberSegmentThreshold Integer URL数字分段收敛阈值
LogSpanIdKey String spanId的索引key: 当CLS索引类型为键值索引时生效

ApmMetricRecord

指标列表单元

被如下接口引用：DescribeApmAllVulCount, DescribeApmSQLInjectionDetail, DescribeApmVulnerabilityCount, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview。

名称 类型 描述
Fields Array of ApmField field数组，用于指标的查询结果
Tags Array of ApmTag tag数组，用于区分 Groupby 的对象

ApmPrometheusRules

展示apm业务系统关联prometheus关系返回体

被如下接口引用：DescribeApmPrometheusRule。

名称 类型 描述
Id Integer 指标匹配规则ID
Name String 指标匹配规则名
注意：此字段可能返回 null，表示取不到有效值。
ServiceName String 规则生效的应用。生效于全部应用就传空字符串
注意：此字段可能返回 null，表示取不到有效值。
Status Integer 指标匹配规则状态：1(启用)、2（不启用）
注意：此字段可能返回 null，表示取不到有效值。
MetricNameRule String 指标匹配规则
注意：此字段可能返回 null，表示取不到有效值。
MetricMatchType Integer 匹配类型：0精准匹配，1前缀匹配，2后缀匹配
注意：此字段可能返回 null，表示取不到有效值。

ApmSampleConfig

采样配置信息

被如下接口引用：CreateApmSampleConfig, DescribeApmSampleConfig。

名称 类型 描述
InstanceKey String 实例ID
ServiceName String 服务名
SampleName String 采样名字
OperationName String 接口名
SpanNum Integer 采样的span数
Status Integer 采样配置开关 0 关 1 开
Tags Array of APMKVItem tags数组
注意：此字段可能返回 null，表示取不到有效值。
SampleRate Integer 采样率
OperationType Integer 0=精确匹配（默认）；1=前缀匹配；2=后缀匹配
注意：此字段可能返回 null，表示取不到有效值。
Id Integer 配置Id
注意：此字段可能返回 null，表示取不到有效值。

ApmServiceMetric

apm应用指标信息

被如下接口引用：DescribeApmServiceMetric。

名称 类型 描述
Fields Array of ApmField filed数组
注意：此字段可能返回 null，表示取不到有效值。
Tags Array of ApmTag tag数组
注意：此字段可能返回 null，表示取不到有效值。
ServiceDetail ServiceDetail 应用信息
注意：此字段可能返回 null，表示取不到有效值。

ApmTag

维度（标签）对象

被如下接口引用：CreateApmInstance, DescribeApmAllVulCount, DescribeApmApplicationConfig, DescribeApmInstances, DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeApmVulnerabilityCount, DescribeApmVulnerabilityDetail, DescribeGeneralApmApplicationConfig, DescribeGeneralMetricData, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview, DescribeTopologyNew, ModifyApmApplicationConfig, ModifyApmInstance, ModifyApmService, ModifyGeneralApmApplicationConfig。

名称 类型 必选 描述
Key String 是 维度Key(列名，标签Key)
Value String 是 维度值（标签值）

ApmVulnerabilityServiceDetail

APM应用实例漏洞相关信息

被如下接口引用：DescribeApmVulnerabilityDetail。

名称 类型 描述
ServiceInstance String 应用实例
注意：此字段可能返回 null，表示取不到有效值。
Path String 漏洞所在jar包路径
注意：此字段可能返回 null，表示取不到有效值。
LastOccurTime Integer 最近发生时间
注意：此字段可能返回 null，表示取不到有效值。

AutoProfilingConfig

自动性能剖析配置

被如下接口引用：DescribeApmApplicationConfig, DescribeGeneralApmApplicationConfig, ModifyApmApplicationConfig。

名称 类型 必选 描述
CpuProfilingEnable Boolean 否 自动CPU剖析任务开关
MemoryProfilingEnable Boolean 否 自动内存剖析任务开关
CpuProfilingThreshold Integer 否 自动CPU剖析任务阈值
MemoryProfilingThreshold Integer 否 自动内存剖析任务阈值
CpuProfilingDuration Integer 否 CPU自动剖析任务时长
MemoryProfilingDuration Integer 否 内存自动剖析任务时长

CVMMeta

CVM元数据

被如下接口引用：DescribeTopologyNew。

名称 类型 必选 描述
Region String 否 地域
注意：此字段可能返回 null，表示取不到有效值。
InstanceID String 否 实例ID
注意：此字段可能返回 null，表示取不到有效值。

ComponentTopologyView

包含了视图中节点组件类型的数量

被如下接口引用：DescribeTopologyNew。

名称 类型 描述
Service Integer 服务纬度的节点数量
注意：此字段可能返回 null，表示取不到有效值。
Database Integer 数据库节点数量
注意：此字段可能返回 null，表示取不到有效值。
MQ Integer 消息队列节点数量
注意：此字段可能返回 null，表示取不到有效值。

Filter

查询过滤参数

被如下接口引用：DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeApmVulnerabilityDetail, DescribeGeneralOTSpanList, DescribeGeneralSpanList, DescribeMetricRecords, DescribeServiceOverview, DescribeTagValues, DescribeTopologyNew。

名称 类型 必选 描述
Type String 是

过滤方式（=, !=, in）
Key String 是

过滤维度名

详情参考实际接口字段描述
Value String 是

过滤值，in过滤方式用逗号分割多个值

GeneralFilter

查询过滤参数

被如下接口引用：DescribeGeneralMetricData。

名称 类型 必选 描述
Key String 是 过滤维度名
Value String 是 过滤值

Instrument

组件

被如下接口引用：DescribeApmApplicationConfig, DescribeGeneralApmApplicationConfig, ModifyApmApplicationConfig。

名称 类型 必选 描述
Name String 否 组件名称
Enable Boolean 否 组件开关

Line

指标曲线数据

被如下接口引用：DescribeGeneralMetricData。

名称 类型 描述
MetricName String 指标名
MetricNameCN String 指标中文名
TimeSerial Array of Integer 时间序列
DataSerial Array of Float 数据序列
Tags Array of ApmTag 维度列表
MetricUnit String 指标数据单位

OrderBy

排序字段

被如下接口引用：DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeGeneralMetricData, DescribeGeneralOTSpanList, DescribeGeneralSpanList, DescribeMetricRecords, DescribeServiceOverview。

名称 类型 必选 描述
Key String 是 需要排序的字段，现支持 startTIme, endTime, duration
Value String 是 asc 顺序排序 / desc 倒序排序

Position

节点位置信息

被如下接口引用：DescribeTopologyNew。

名称 类型 必选 描述
X Float 否 节点位置横坐标
注意：此字段可能返回 null，表示取不到有效值。
Y Float 否 节点位置纵坐标
注意：此字段可能返回 null，表示取不到有效值。

QueryMetricItem

查询

被如下接口引用：DescribeApmSQLInjectionDetail, DescribeMetricRecords, DescribeServiceOverview。

名称 类型 必选 描述
MetricName String 是 指标名
Compares Array of String 否 同比，现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比)
Compare String 否 同比，已弃用，不建议使用

Resource

资源层信息

被如下接口引用：DescribeTopologyNew。

名称 类型 必选 描述
Type Array of String 否 资源类型
注意：此字段可能返回 null，表示取不到有效值。
TKEMeta Array of TkeMeta 否 tke资源层信息
CVMMeta Array of CVMMeta 否 cvm资源信息
注意：此字段可能返回 null，表示取不到有效值。

SelectorView

包含了节点的组件数量和健康度数量

被如下接口引用：DescribeTopologyNew。

名称 类型 描述
Component ComponentTopologyView 组件数量
注意：此字段可能返回 null，表示取不到有效值。

Selectors

视图方案勾选情况

被如下接口引用：DescribeTopologyNew。

名称 类型 必选 描述
Component Array of String 否 组件勾选情况
注意：此字段可能返回 null，表示取不到有效值。

ServiceDetail

应用详细信息

被如下接口引用：DescribeApmServiceMetric。

名称 类型 必选 描述
ServiceID String 否

应用ID


注意：此字段可能返回 null，表示取不到有效值。
InstanceKey String 否

业务系统ID


注意：此字段可能返回 null，表示取不到有效值。
AppID Integer 否

用户appid


注意：此字段可能返回 null，表示取不到有效值。
CreateUIN String 否

主账号uin


注意：此字段可能返回 null，表示取不到有效值。
ServiceName String 否

应用名


注意：此字段可能返回 null，表示取不到有效值。
ServiceDescription String 否

应用描述


注意：此字段可能返回 null，表示取不到有效值。
Region String 否

地域


注意：此字段可能返回 null，表示取不到有效值。
Tags Array of ApmTag 否

标签


注意：此字段可能返回 null，表示取不到有效值。
InstanceName String 否

业务系统名称
EnableThresholdConfig Boolean 否

阈值配置开关。true 表示使用应用级阈值；false 表示使用业务系统级阈值


注意：此字段可能返回 null，表示取不到有效值。
ErrRateThreshold Integer 否

错误率阈值（%），用于判断应用健康状态为"红色"

单位：%


注意：此字段可能返回 null，表示取不到有效值。
ResponseDurationWarningThreshold Integer 否

响应时间预警阈值（ms），用于判断应用健康状态为"黄色"

单位：ms


注意：此字段可能返回 null，表示取不到有效值。

Span

Span 对象

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
TraceID String 否 Trace ID
Logs Array of SpanLog 否 日志
Tags Array of SpanTag 否 标签
Process SpanProcess 否 上报应用服务信息
Timestamp Integer 否 产生时间戳(毫秒)
OperationName String 否 Span 名称
References Array of SpanReference 否 关联关系
StartTime Integer 否 产生时间戳(微秒)
Duration Integer 否 持续耗时(微妙)
SpanID String 否 Span ID
StartTimeMillis Integer 否 产生时间戳(毫秒)
ParentSpanID String 否 Parent Span ID

SpanLog

Span日志部分

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
Timestamp Integer 是 日志时间戳
Fields Array of SpanTag 是 标签

SpanProcess

服务相关信息

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
ServiceName String 是 应用服务名称
Tags Array of SpanTag 是 Tags 标签数组

SpanReference

Span上下游关联关系

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
RefType String 是 关联关系类型
SpanID String 是 Span ID
TraceID String 是 Trace ID

SpanTag

标签

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
Type String 是 标签类型
Key String 是 标签Key
注意：此字段可能返回 null，表示取不到有效值。
Value String 是 标签值
注意：此字段可能返回 null，表示取不到有效值。

TkeMeta

tke资源元数据

被如下接口引用：DescribeTopologyNew。

名称 类型 必选 描述
Region String 否 地域
ClusterID String 否 集群ID
PodName String 否 pod name
Namespace String 否 命名空间
Deployment String 否 工作负载
PodIP String 否 pod ip
NodeIP String 否 node ip

TopologyEdgeNew

拓扑图边定义

被如下接口引用：DescribeTopologyNew。

名称 类型 描述
Source String 源节点
Id String 边ID
Weight Float 边权重
注意：此字段可能返回 null，表示取不到有效值。
Target String 目标节点
Duration Float 响应时间
注意：此字段可能返回 null，表示取不到有效值。
ErrRate Float 错误率
注意：此字段可能返回 null，表示取不到有效值。
Qps Float 吞吐量
注意：此字段可能返回 null，表示取不到有效值。
Type String 边类型
注意：此字段可能返回 null，表示取不到有效值。
Color String 边颜色
注意：此字段可能返回 null，表示取不到有效值。
SqlRequestCount Float Sql调用数
注意：此字段可能返回 null，表示取不到有效值。
SqlErrorRequestCount Float Sql调用错误数
注意：此字段可能返回 null，表示取不到有效值。
SourceComp String 边上源节点类型 应用/MQ/DB
TargetComp String 边上目标节点类型 应用/MQ/DB

TopologyNode

拓扑图边节点

被如下接口引用：DescribeTopologyNew。

名称 类型 描述
ErrRate Float 错误率
注意：此字段可能返回 null，表示取不到有效值。
Kind String 节点类型
注意：此字段可能返回 null，表示取不到有效值。
Name String 节点名
Weight Float 节点权重
注意：此字段可能返回 null，表示取不到有效值。
Color String 节点颜色
注意：此字段可能返回 null，表示取不到有效值。
Duration Float 响应时间
注意：此字段可能返回 null，表示取不到有效值。
Qps Float 吞吐量
注意：此字段可能返回 null，表示取不到有效值。
Type String 节点类型
注意：此字段可能返回 null，表示取不到有效值。
Id String 节点ID
Size String 节点大小
注意：此字段可能返回 null，表示取不到有效值。
IsModule Boolean 节点是否为组件类型
注意：此字段可能返回 null，表示取不到有效值。
Position Position 节点位置信息
注意：此字段可能返回 null，表示取不到有效值。
Tags Array of ApmTag 节点标签
注意：此字段可能返回 null，表示取不到有效值。
CanDrillDown Boolean 节点是否可以下钻
注意：此字段可能返回 null，表示取不到有效值。
Resource Resource 资源层信息
注意：此字段可能返回 null，表示取不到有效值。
NodeView String 拓扑节点视图名字
ConsumerDuration Float MQ 消费者视角的响应时间 ms
ConsumerErrRate Float MQ 消费者视角的错误率 %
ConsumerQps Float MQ 消费者视角的吞吐量
ServiceId String 应用 ID
上一篇: CreateProfileTask下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈