tencent cloud

APIs

文档APIsApplication Performance ManagementData Types

Data Types

聚焦模式
字号
最后更新时间： 2026-05-08 20:48:36

APMKV

APM floating-point number type key-value pair.

Used by actions: DescribeApmAllVulCount, DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeApmVulnerabilityCount, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview.

Name Type Required Description
Key String No Key value definition.
Value Float No Value definition.

APMKVItem

Common kv structure of apm.

Used by actions: CreateApmSampleConfig, DescribeApmAllVulCount, DescribeApmSQLInjectionDetail, DescribeApmSampleConfig, DescribeApmServiceMetric, DescribeApmVulnerabilityCount, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview, ModifyApmSampleConfig.

Name Type Required Description
Key String Yes Key value definition.
Value String Yes Value definition.

AgentOperationConfigView

Related configurations of the probe APIs.

Used by actions: DescribeApmApplicationConfig, ModifyApmApplicationConfig.

Name Type Required Description
RetentionValid Boolean No Whether allowlist configuration is enabled for the current API.
Note: This field may return null, indicating that no valid values can be obtained.
IgnoreOperation String No Effective when RetentionValid is false. It indicates blocklist configuration in API settings. The APIs specified in the configuration do not support collection.
Note: This field may return null, indicating that no valid values can be obtained.
RetentionOperation String No Effective when RetentionValid is true. It indicates allowlist configuration in API settings. Only the APIs specified in the configuration support collection.
Note: This field may return null, indicating that no valid values can be obtained.

ApmAgentInfo

APM agent information.

Used by actions: DescribeApmAgent.

Name Type Description
AgentDownloadURL String Agent download address.
CollectorURL String Collector reporting address.
Token String Token information.
PublicCollectorURL String Public network reporting address.
InnerCollectorURL String Self-Developed vpc report address.
PrivateLinkCollectorURL String Private link reporting address.

ApmAppConfig

Querying application configuration response parameters structure.

Used by actions: DescribeApmApplicationConfig.

Name Type Description
InstanceKey String

Instance ID
ServiceName String

Service name
UrlConvergenceSwitch Integer

URL convergence switch
UrlConvergenceThreshold Integer

URL convergence threshold
UrlConvergence String

URL regular convergence
ExceptionFilter String

Exception filter regular
ErrorCodeFilter String

Error code filtering
Components String

Service component type
UrlExclude String

URL exclusion regular
LogSource String

Log source
LogRegion String

Log region
IsRelatedLog Integer

Whether logging is enabled 0 Disabled 1 Enabled
LogTopicID String

Log topic ID
IgnoreOperationName String

Interface Names to Filter
LogSet String

CLS logset
TraceRateLimit Integer

Number of traces reported by the probe per second
EnableSnapshot Boolean

Whether thread profiling is enabled
SnapshotTimeout Integer

Timeout threshold for thread profiling
AgentEnable Boolean

Whether to enable agent
InstrumentList Array of Instrument

Component list


Note: This field may return null, indicating that no valid values can be obtained.
TraceSquash Boolean

Whether to enable link compression
EventEnable Boolean

Whether the application diagnosis switch is enabled
AgentOperationConfigView AgentOperationConfigView

probe API related configuration


Note: This field may return null, indicating that no valid values can be obtained.
EnableLogConfig Boolean

Whether the application log configuration is enabled
ServiceID String

Application ID


Note: This field may return null, indicating that no valid values can be obtained.
EnableDashboardConfig Boolean

Whether the dashboard configuration is enabled: false (disabled, consistent with the business system)/true (enabled, hierarchical configuration)


Note: This field may return null, indicating that no valid values can be obtained.
IsRelatedDashboard Integer

Whether dashboard is associated: 0 Disabled 1 Enabled


Note: This field may return null, indicating that no valid values can be obtained.
DashboardTopicID String

dashboard ID


Note: This field may return null, indicating that no valid values can be obtained.
EnableSecurityConfig Boolean

Whether the application-level configuration is enabled


Note: This field may return null, indicating that no valid values can be obtained.
IsInstrumentationVulnerabilityScan Integer

Whether the component vulnerability detection is enabled


Note: This field may return null, indicating that no valid values can be obtained.
IsSqlInjectionAnalysis Integer

Whether SQL injection analysis is enabled


Note: This field may return null, indicating that no valid values can be obtained.
IsRemoteCommandExecutionAnalysis Integer

Whether remote command execution analysis is enabled


Note: This field may return null, indicating that no valid values can be obtained.
IsMemoryHijackingAnalysis Integer

Whether Java Webshell detection and analysis is enabled


Note: This field may return null, indicating that no valid values can be obtained.
LogIndexType Integer

CLS index type (0=full-text index, 1=key-value index)
LogTraceIdKey String

Index key of traceId: This parameter is valid only when the CLS index type is key-value index.
IsDeleteAnyFileAnalysis Integer

Whether to enable file deletion detection (0 - disabled, 1 - enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsReadAnyFileAnalysis Integer

Whether to enable arbitrary file read detection (0 - disabled, 1 - enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsUploadAnyFileAnalysis Integer

Whether to enable arbitrary file upload detection (0 - disabled, 1 - enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsIncludeAnyFileAnalysis Integer

Whether to enable detection of arbitrary files (0 - disabled, 1 - enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsDirectoryTraversalAnalysis Integer

Whether path traversal detection is enabled (0-disabled, 1-enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsTemplateEngineInjectionAnalysis Integer

Whether to enable template engine injection detection (0-disable, 1-enable)


Note: This field may return null, indicating that no valid values can be obtained.
IsScriptEngineInjectionAnalysis Integer

Whether script engine injection detection is enabled (0-disabled, 1-enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsExpressionInjectionAnalysis Integer

Whether expression injection detection is enabled (0-disabled, 1-enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsJNDIInjectionAnalysis Integer

Whether JNDI injection detection is enabled (0-disabled, 1-enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsJNIInjectionAnalysis Integer

Whether JNI injection detection is enabled (0 - disabled, 1 - enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsWebshellBackdoorAnalysis Integer

Whether to enable Webshell backdoor detection (0 - disabled, 1 - enabled)


Note: This field may return null, indicating that no valid values can be obtained.
IsDeserializationAnalysis Integer

Whether deserialization detection is enabled (0-disabled, 1-enabled)


Note: This field may return null, indicating that no valid values can be obtained.
UrlAutoConvergenceEnable Boolean

API name auto convergence switch (0-off, 1-on)
UrlLongSegmentThreshold Integer

URL long segment convergence threshold
UrlNumberSegmentThreshold Integer

URL digit segment convergence threshold
DisableMemoryUsed Integer

Fuse memory threshold of the probe
DisableCpuUsed Integer

Probe fuse CPU threshold
DbStatementParametersEnabled Boolean

Whether SQL parameter access is enabled
SlowSQLThresholds Array of ApmTag

Slow SQL threshold
EnableDesensitizationRule Integer

Whether the masking rule is enabled
DesensitizationRule String

Masking rule
LogSpanIdKey String

Index key of spanId: This parameter is valid only when the CLS index type is key-value index.
AutoProfilingConfig AutoProfilingConfig

Automated performance analysis configuration
EnableThresholdConfig Boolean

Threshold configuration switch. true means use application level threshold; false means use business system level threshold.
ErrRateThreshold Integer

Error rate threshold (%) used to judge the application health status as "red".
ResponseDurationWarningThreshold Integer

Alert threshold for response time (ms), used to judge the application health status as "yellow".
UseDefaultFuseConfig Boolean

Whether to use the built-in fuse threshold of the probe by default

ApmApplicationConfigView

Application-Related configuration list items.

Used by actions: DescribeGeneralApmApplicationConfig.

Name Type Required Description
InstanceKey String No

Business system ID
ServiceName String No

Application name
OperationNameFilter String No

Interface Filtering
ExceptionFilter String No

Error type filtering
ErrorCodeFilter String No

HTTP status code filtering
EventEnable Boolean No

Application diagnosis switch (abandoned)
UrlConvergenceSwitch Integer No

URL convergence switch 0 Off 1 On
UrlConvergenceThreshold Integer No

URL convergence threshold
UrlConvergence String No

URL regular convergence rules
UrlExclude String No

URL exclusion rule regex
IsRelatedLog Integer No

Whether logging is enabled 0 Disabled 1 Enabled
LogSource String No

Log source
LogSet String No

Logset
LogTopicID String No

Log topic
SnapshotEnable Boolean No

Method stack snapshot switch. Enabled indicates true. false indicates disabled.
SnapshotTimeout Integer No

Slow call monitoring trigger threshold
AgentEnable Boolean No

Master switch for probes
InstrumentList Array of Instrument No

Component list toggle (abandoned)
TraceSquash Boolean No

Link compression switch (abandoned)
AgentIgnoreOperation String No

Link filtering configuration
EnableSecurityConfig Boolean No

Enable the application security switch
IsSqlInjectionAnalysis Integer No

Whether SQL injection detection is enabled
IsInstrumentationVulnerabilityScan Integer No

Whether component vulnerability detection is enabled
IsRemoteCommandExecutionAnalysis Integer No

Whether remote command execution detection is enabled
IsMemoryHijackingAnalysis Integer No

Whether memory leakage detection is enabled
IsDeleteAnyFileAnalysis Integer No

Whether to enable detection of any file deletion
IsReadAnyFileAnalysis Integer No

Whether to enable arbitrary file read detection
IsUploadAnyFileAnalysis Integer No

Whether to enable arbitrary file upload detection
IsIncludeAnyFileAnalysis Integer No

Whether to enable detection of arbitrary files
IsDirectoryTraversalAnalysis Integer No

Whether path traversal detection is enabled
IsTemplateEngineInjectionAnalysis Integer No

Whether to enable template engine injection detection
IsScriptEngineInjectionAnalysis Integer No

Whether script engine injection detection is enabled
IsExpressionInjectionAnalysis Integer No

Whether expression injection detection is enabled
IsJndiInjectionAnalysis Integer No

Whether JNDI injection detection is enabled
IsJniInjectionAnalysis Integer No

Whether JNI injection detection is enabled
IsWebshellBackdoorAnalysis Integer No

Whether Webshell backdoor detection is enabled
IsDeserializationAnalysis Integer No

Whether deserialization detection is enabled
EnableDashboardConfig Boolean No

Whether the console switch is enabled
IsRelatedDashboard Integer No

Whether to associate with Dashboard
DashboardTopicID String No

Dashboard topic
DisableMemoryUsed Integer No

Fuse memory threshold of the probe
DisableCpuUsed Integer No

Probe fuse CPU threshold
DbStatementParametersEnabled Boolean No

Whether SQL parameter access is enabled
SlowSQLThresholds Array of ApmTag No

Slow SQL threshold
EnableDesensitizationRule Integer No

Whether the masking rule is enabled
DesensitizationRule String No

Masking rule
AutoProfilingConfig AutoProfilingConfig No

Automated performance analysis task configuration
EnableThresholdConfig Boolean No

Threshold configuration switch
ErrRateThreshold Integer No

Error rate threshold

Unit: %
ResponseDurationWarningThreshold Integer No

Alert threshold of response time

Unit: ms
UseDefaultFuseConfig Boolean No

Whether to use the default fuse threshold of the probe

ApmAssociation

Shows the association between the apm business system and other cloud products in the return format.

Used by actions: DescribeApmAssociation.

Name Type Description
PeerId String

Instance ID of the associated product


Note: This field may return null, indicating that no valid values can be obtained.
Status Integer

Association status: 1 (enabled), 2 (not enabled), 3 (invalid)


Note: This field may return null, indicating that no valid values can be obtained.
Topic String

CKafka message topic
MetricTopic String

Ckafka consumption topic

Used for Kafka metric delivery

ApmField

Metric dimension information.

Used by actions: DescribeApmAllVulCount, DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeApmVulnerabilityCount, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview.

Name Type Description
Key String Metric name.
Value Float Indicator numerical value.
Unit String Units corresponding to the metric.
CompareVals Array of APMKVItem Year-Over-Year result array, recommended to use.
Note: this field may return null, indicating that no valid values can be obtained.
LastPeriodValue Array of APMKV Indicator numerical value of the previous period in year-over-year comparison.
Note: this field may return null, indicating that no valid values can be obtained.
CompareVal String Year-On-Year metric value. deprecated, not recommended for use.
NameCN String Metric Chinese Name
NameEN String Metric English name

ApmInstanceDetail

APM business system information.

Used by actions: DescribeApmInstances.

Name Type Description
InstanceId String Business system id.
Name String Business system name.
Description String Business system description information.
Status Integer Status of the business system.
{Initializing; running; throttling}.
Region String Region where the business system belongs.
Tags Array of ApmTag Business system tag list.
AppId Integer AppID information.
CreateUin String Creator uin.
AmountOfUsedStorage Float Storage used (unit: mb).
ServiceCount Integer Quantity of server applications of the business system.
CountOfReportSpanPerDay Integer Average daily reported span count.
TraceDuration Integer Retention period of trace data (unit: days).
SpanDailyCounters Integer Business system report limit.
BillingInstance Integer Whether the business system billing is Activated (0 = not activated, 1 = activated).
ErrRateThreshold Integer Error warning line (unit: %).
SampleRate Integer Sampling rate (unit: %).
ErrorSample Integer Error sampling switch (0: off, 1: on).
SlowRequestSavedThreshold Integer Sampling slow call saving threshold (unit: ms).
LogRegion String CLS log region.
LogSource String Log source.
IsRelatedLog Integer Log feature switch (0: off; 1: on).
LogTopicID String Log topic id.
ClientCount Integer Quantity of client applications of the business system.
TotalCount Integer The quantity of active applications in this business system in the last two days.
LogSet String CLS log set.
MetricDuration Integer Retention period of metric data (unit: days).
CustomShowTags Array of String List of custom display tags.
PayMode Integer Business system billing mode (1: prepaid, 0: pay-as-you-go).
PayModeEffective Boolean Indicates whether the billing mode of the business system takes effect.
ResponseDurationWarningThreshold Integer Response time warning line (unit: ms).
Free Integer Whether it is free (0 = no; 1 = limited free; 2 = completely free), default 0.
DefaultTSF Integer Indicates whether it is the default business system of tsf (0 = no, 1 = yes).
IsRelatedDashboard Integer Whether to associate the dashboard (0 = off, 1 = on).
DashboardTopicID String Associated dashboard id.
IsInstrumentationVulnerabilityScan Integer Whether to enable component vulnerability detection (0 = no, 1 = yes).
IsSqlInjectionAnalysis Integer Whether to enable sql injection analysis (0: off, 1: on).
StopReason Integer Reasons for traffic throttling.
Official version quota;.
Trial version quota.
Trial version expiration;.
Account in arrears.
}.
IsRemoteCommandExecutionAnalysis Integer Whether to enable detection of remote command execution (0 = disabled; 1 = enabled).
IsMemoryHijackingAnalysis Integer Whether to enable detection of Java webshell execution (0 = disabled; 1 = enabled).
LogIndexType Integer CLS index type. (0 = full-text index; 1 = key-value index).
LogTraceIdKey String Index key of traceId. It is valid when the CLS index type is key-value index.
IsDeleteAnyFileAnalysis Integer Whether to enable the detection of deleting arbitrary files. (0 - disabled; 1: enabled.)
IsReadAnyFileAnalysis Integer Whether to enable the detection of reading arbitrary files. (0 - disabled; 1 - enabled.)
IsUploadAnyFileAnalysis Integer Whether to enable the detection of uploading arbitrary files. (0 - disabled; 1 - enabled.)
IsIncludeAnyFileAnalysis Integer Whether to enable the detection of the inclusion of arbitrary files. (0: disabled, 1: enabled.)
IsDirectoryTraversalAnalysis Integer Whether to enable traversal detection of the directory. (0 - disabled; 1 - enabled).
IsTemplateEngineInjectionAnalysis Integer Whether to enable template engine injection detection. (0: disabled; 1: enabled.)
IsScriptEngineInjectionAnalysis Integer Whether to enable script engine injection detection. (0 - disabled; 1 - enabled.)
IsExpressionInjectionAnalysis Integer Whether to enable expression injection detection. (0 - disabled; 1 - enabled.)
IsJNDIInjectionAnalysis Integer Whether to enable JNDI injection detection. (0 - disabled; 1 - enabled.)
IsJNIInjectionAnalysis Integer Whether to enable JNI injection detection. (0 - disabled, 1 - enabled).
IsWebshellBackdoorAnalysis Integer Whether to enable Webshell backdoor detection. (0 - disabled; 1 - enabled).
IsDeserializationAnalysis Integer Whether to enable deserialization detection. (0 - disabled; 1 - enabled).
Token String Business system authentication token.
UrlLongSegmentThreshold Integer Convergence threshold for URL long segments.
UrlNumberSegmentThreshold Integer Convergence threshold for URL numerical segments.
LogSpanIdKey String Index key of spanId: This parameter is valid only when the CLS index type is key-value index

ApmMetricRecord

Metric list cell.

Used by actions: DescribeApmAllVulCount, DescribeApmSQLInjectionDetail, DescribeApmVulnerabilityCount, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview.

Name Type Description
Fields Array of ApmField Field array, used for the query result of indicators.
Tags Array of ApmTag Tag array, used to distinguish the objects of groupby.

ApmPrometheusRules

Shows the association between the apm business system and prometheus in the return format.

Used by actions: DescribeApmPrometheusRule.

Name Type Description
Id Integer Metric match rule ID.
Name String Metric match rule name.
Note: This field may return null, indicating that no valid values can be obtained.
ServiceName String Applications where the rule takes effect. input an empty string for all applications.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Specifies the metric match rule status: 1 (enabled), 2 (disabled).
Note: This field may return null, indicating that no valid values can be obtained.
MetricNameRule String Specifies the metric match rule.
Note: This field may return null, indicating that no valid values can be obtained.
MetricMatchType Integer Match type: 0 - precision match, 1 - prefix match, 2 - suffix match.
Note: This field may return null, indicating that no valid values can be obtained.

ApmSampleConfig

Sampling configuration

Used by actions: CreateApmSampleConfig, DescribeApmSampleConfig.

Name Type Description
InstanceKey String Instance ID.
ServiceName String Service name.
SampleName String Sampling name
OperationName String API name.
SpanNum Integer Number of spans sampled
Status Integer Sampling configuration switch. 0: Off; 1: On
Tags Array of APMKVItem Tag array
Note: This field may return null, indicating that no valid values can be obtained.
SampleRate Integer Sampling rate.
OperationType Integer Specifies the matching method. 0: exact match (default); 1: prefix match; 2: suffix match.
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer Configuration ID.
Note: This field may return null, indicating that no valid values can be obtained.

ApmServiceMetric

APM application metric information.

Used by actions: DescribeApmServiceMetric.

Name Type Description
Fields Array of ApmField Field array.
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of ApmTag Tag array
Note: This field may return null, indicating that no valid values can be obtained.
ServiceDetail ServiceDetail Application information
Note: This field may return null, indicating that no valid values can be obtained.

ApmTag

Dimension (tag) object.

Used by actions: CreateApmInstance, DescribeApmAllVulCount, DescribeApmApplicationConfig, DescribeApmInstances, DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeApmVulnerabilityCount, DescribeApmVulnerabilityDetail, DescribeGeneralApmApplicationConfig, DescribeGeneralMetricData, DescribeMetricRecords, DescribeOPRAllVulCount, DescribeServiceOverview, DescribeTopologyNew, ModifyApmApplicationConfig, ModifyApmInstance, ModifyApmService, ModifyGeneralApmApplicationConfig.

Name Type Required Description
Key String Yes Dimension key (column name, Tag key).
Value String Yes Dimension value (tag value).

ApmVulnerabilityServiceDetail

Vulnerability-related information of APM application instance

Used by actions: DescribeApmVulnerabilityDetail.

Name Type Description
ServiceInstance String Application instance
Note: This field may return null, indicating that no valid values can be obtained.
Path String Path of the jar package with the vulnerability
Note: This field may return null, indicating that no valid values can be obtained.
LastOccurTime Integer Last occurrence time
Note: This field may return null, indicating that no valid values can be obtained.

AutoProfilingConfig

Automated performance analysis configuration

Used by actions: DescribeApmApplicationConfig, DescribeGeneralApmApplicationConfig, ModifyApmApplicationConfig.

Name Type Required Description
CpuProfilingEnable Boolean No Auto CPU profiling task switch
MemoryProfilingEnable Boolean No Auto memory profiling task switch
CpuProfilingThreshold Integer No Auto CPU profiling task threshold
MemoryProfilingThreshold Integer No Automated memory profiling task threshold
CpuProfilingDuration Integer No CPU auto profiling task duration
MemoryProfilingDuration Integer No Memory auto profiling task duration

CVMMeta

CVM metadata.

Used by actions: DescribeTopologyNew.

Name Type Required Description
Region String No Region.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceID String No Instance ID.
Note: This field may return null, indicating that no valid values can be obtained.

ComponentTopologyView

Contains the quantity of node component types in the view.

Used by actions: DescribeTopologyNew.

Name Type Description
Service Integer Number of nodes at the service level.
Note: This field may return null, indicating that no valid values can be obtained.
Database Integer Node count of the database.
Note: This field may return null, indicating that no valid values can be obtained.
MQ Integer Node count of the message queue.
Note: This field may return null, indicating that no valid values can be obtained.

Filter

Queries filter parameters.

Used by actions: DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeApmVulnerabilityDetail, DescribeGeneralOTSpanList, DescribeGeneralSpanList, DescribeMetricRecords, DescribeServiceOverview, DescribeTagValues, DescribeTopologyNew.

Name Type Required Description
Type String Yes

Filter method (=, !=, in)
Key String Yes

Filter dimension name

For details, see the actual interface field description
Value String Yes

Filter value. Use comma-separated multiple values for in filtering method.

GeneralFilter

Queries filter parameters.

Used by actions: DescribeGeneralMetricData.

Name Type Required Description
Key String Yes Filter dimension name.
Value String Yes Values after filtering.

Instrument

Component.

Used by actions: DescribeApmApplicationConfig, DescribeGeneralApmApplicationConfig, ModifyApmApplicationConfig.

Name Type Required Description
Name String No Component name.
Enable Boolean No Component switch.

Line

Metric curve data.

Used by actions: DescribeGeneralMetricData.

Name Type Description
MetricName String Metric name.
MetricNameCN String Metric chinese name.
TimeSerial Array of Integer Time series.
DataSerial Array of Float Data sequence.
Tags Array of ApmTag Dimension list.
MetricUnit String Metric data unit

OrderBy

Sorting fields.

Used by actions: DescribeApmSQLInjectionDetail, DescribeApmServiceMetric, DescribeGeneralMetricData, DescribeGeneralOTSpanList, DescribeGeneralSpanList, DescribeMetricRecords, DescribeServiceOverview.

Name Type Required Description
Key String Yes Sort field (starttime, endtime, duration are supported).
Value String Yes ASC: sequential sorting / desc: reverse sorting.

Position

Node location information

Used by actions: DescribeTopologyNew.

Name Type Required Description
X Float No Node horizontal coordinate
Note: This field may return null, indicating that no valid values can be obtained.
Y Float No Node vertical coordinate
Note: This field may return null, indicating that no valid values can be obtained.

QueryMetricItem

Querying.

Used by actions: DescribeApmSQLInjectionDetail, DescribeMetricRecords, DescribeServiceOverview.

Name Type Required Description
MetricName String Yes Metric name.
Compares Array of String No Year-Over-Year comparison is now supported for comparebyyesterday (compared to yesterday) and comparebylastweek (compared to last week).
Compare String No Year-On-Year, deprecated, not recommended for use.

Resource

Resource layer information.

Used by actions: DescribeTopologyNew.

Name Type Required Description
Type Array of String No Resource type.
Note: This field may return null, indicating that no valid values can be obtained.
TKEMeta Array of TkeMeta No TKE resource layer information.
CVMMeta Array of CVMMeta No CVM resource information.
Note: This field may return null, indicating that no valid values can be obtained.

SelectorView

Contains the quantities of components and healthy nodes in the nodes.

Used by actions: DescribeTopologyNew.

Name Type Description
Component ComponentTopologyView Component Count
Note: This field may return null, indicating that no valid values can be obtained.

Selectors

Selection status of the topology view.

Used by actions: DescribeTopologyNew.

Name Type Required Description
Component Array of String No Selection status of the component.
Note: This field may return null, indicating that no valid values can be obtained.

ServiceDetail

Detailed information about applications.

Used by actions: DescribeApmServiceMetric.

Name Type Required Description
ServiceID String No

Application ID


Note: This field may return null, indicating that no valid values can be obtained.
InstanceKey String No

Business system ID


Note: This field may return null, indicating that no valid values can be obtained.
AppID Integer No

User appid


Note: This field may return null, indicating that no valid values can be obtained.
CreateUIN String No

main account uin


Note: This field may return null, indicating that no valid values can be obtained.
ServiceName String No

Application name


Note: This field may return null, indicating that no valid values can be obtained.
ServiceDescription String No

Application description


Note: This field may return null, indicating that no valid values can be obtained.
Region String No

Region


Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of ApmTag No

Tag


Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String No

Business system name
EnableThresholdConfig Boolean No

Threshold configuration switch. true means use application level threshold; false means use business system level threshold.


Note: This field may return null, indicating that no valid values can be obtained.
ErrRateThreshold Integer No

Error rate threshold (%) used to judge the application health status as "red".

Unit: %


Note: This field may return null, indicating that no valid values can be obtained.
ResponseDurationWarningThreshold Integer No

Alert threshold for response time (ms), used to judge application health status as "yellow".

Unit: ms


Note: This field may return null, indicating that no valid values can be obtained.

Span

Span object.

Used by actions: DescribeGeneralSpanList.

Name Type Required Description
TraceID String No Trace ID
Logs Array of SpanLog No Log.
Tags Array of SpanTag No Tag.
Process SpanProcess No Submit application service information.
Timestamp Integer No Generated timestamp (ms).
OperationName String No Span name.
References Array of SpanReference No Association relationship.
StartTime Integer No Generated timestamp (ms).
Duration Integer No Duration (ms).
SpanID String No Span ID
StartTimeMillis Integer No Generated timestamp (ms).
ParentSpanID String No Parent Span ID

SpanLog

Span log section.

Used by actions: DescribeGeneralSpanList.

Name Type Required Description
Timestamp Integer Yes Log timestamp.
Fields Array of SpanTag Yes Tag.

SpanProcess

Service information.

Used by actions: DescribeGeneralSpanList.

Name Type Required Description
ServiceName String Yes Application service name.
Tags Array of SpanTag Yes Tags Tag array.

SpanReference

Upstream and downstream relationships of span.

Used by actions: DescribeGeneralSpanList.

Name Type Required Description
RefType String Yes Type of association relationship.
SpanID String Yes Span ID
TraceID String Yes Trace ID

SpanTag

Tag.

Used by actions: DescribeGeneralSpanList.

Name Type Required Description
Type String Yes Tag type.
Key String Yes Tag key.
Note: this field may return null, indicating that no valid values can be obtained.
Value String Yes Tag value
.
Note: this field may return null, indicating that no valid values can be obtained.

TkeMeta

TKE resource metadata.

Used by actions: DescribeTopologyNew.

Name Type Required Description
Region String No Region.
ClusterID String No Cluster ID
PodName String No pod name
Namespace String No Namespace
Deployment String No workload
PodIP String No pod ip
NodeIP String No node ip

TopologyEdgeNew

Topology edge definition

Used by actions: DescribeTopologyNew.

Name Type Description
Source String Source node
Id String Edge ID
Weight Float Edge weight
Note: This field may return null, indicating that no valid values can be obtained.
Target String Target node
Duration Float response time
Note: This field may return null, indicating that no valid values can be obtained.
ErrRate Float Error rate
Note: This field may return null, indicating that no valid values can be obtained.
Qps Float throughput
Note: This field may return null, indicating that no valid values can be obtained.
Type String Edge type
Note: This field may return null, indicating that no valid values can be obtained.
Color String Edge color
Note: This field may return null, indicating that no valid values can be obtained.
SqlRequestCount Float SQL call count
Note: This field may return null, indicating that no valid values can be obtained.
SqlErrorRequestCount Float SQL call error count
Note: This field may return null, indicating that no valid values can be obtained.
SourceComp String Source node type on the edge of the topology diagram. Application/MQ/DB.
TargetComp String Target node type on the edge of the topology diagram. Application/MQ/DB.

TopologyNode

Topology graph edge node

Used by actions: DescribeTopologyNew.

Name Type Description
ErrRate Float Error rate
Note: This field may return null, indicating that no valid values can be obtained.
Kind String Node type.
Note: This field may return null, indicating that no valid values can be obtained.
Name String Node name
Weight Float Node weight
Note: This field may return null, indicating that no valid values can be obtained.
Color String Node color
Note: This field may return null, indicating that no valid values can be obtained.
Duration Float response time
Note: This field may return null, indicating that no valid values can be obtained.
Qps Float throughput
Note: This field may return null, indicating that no valid values can be obtained.
Type String Node type.
Note: This field may return null, indicating that no valid values can be obtained.
Id String Node ID
Size String Node size
Note: This field may return null, indicating that no valid values can be obtained.
IsModule Boolean Indicate whether the node is a component
Note: This field may return null, indicating that no valid values can be obtained.
Position Position Node location information
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of ApmTag Node tags
Note: This field may return null, indicating that no valid values can be obtained.
CanDrillDown Boolean Whether the node supports drill-down.
Note: This field may return null, indicating that no valid values can be obtained.
Resource Resource Resource layer information.
Note: This field may return null, indicating that no valid values can be obtained.
NodeView String Name of the topology node view.
ConsumerDuration Float Message consumption time of the MQ consumer, in ms.
ConsumerErrRate Float Error rate of the MQ consumers, in %.
ConsumerQps Float Throughput of the message queue (MQ) consumer.
ServiceId String Application ID.
上一篇: CreateProfileTask下一篇: Error Codes

帮助和支持

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

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

文档反馈