tencent cloud

All product documents
Application Performance Management
DocumentationApplication Performance ManagementAPI DocumentationData Types
Data Types
Download PDF
Last updated: 2025-02-25 15:58:17
Data Types
Last updated: 2025-02-25 15:58:17
Download PDF

APMKV

APM floating-point number type key-value pair.

Used by actions: DescribeMetricRecords, DescribeServiceOverview.

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

APMKVItem

Common kv structure of apm.

Used by actions: DescribeMetricRecords, DescribeServiceOverview.

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

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.

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 API filtering.
ExceptionFilter String No Error type filtering.
ErrorCodeFilter String No HTTP status code filtering.
EventEnable Boolean No Application diagnosis switch (deprecated).
UrlConvergenceSwitch Integer No URL convergence switch. 0: off; 1: on.
UrlConvergenceThreshold Integer No URL convergence threshold.
UrlConvergence String No URL convergence rule in the form of a regular expression.
UrlExclude String No URL exclusion rule in the form of a regular expression.
IsRelatedLog Integer No Log feature switch. 0: off; 1: on.
LogSource String No Log source.
LogSet String No Log set.
LogTopicID String No Log topic.
SnapshotEnable Boolean No Method stack snapshot switch: true to enable, false to disable.
SnapshotTimeout Integer No Slow call listening trigger threshold.
AgentEnable Boolean No Probe master switch.
InstrumentList Array of Instrument No Component list switch (deprecated).
TraceSquash Boolean No Link compression switch (deprecated).

ApmField

Metric dimension information.

Used by actions: DescribeMetricRecords, 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.

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.
}.

ApmMetricRecord

Metric list cell.

Used by actions: DescribeMetricRecords, 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.

ApmTag

Dimension (tag) object.

Used by actions: CreateApmInstance, DescribeApmInstances, DescribeGeneralMetricData, DescribeMetricRecords, DescribeServiceOverview, ModifyApmInstance, ModifyGeneralApmApplicationConfig.

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

Filter

Queries filter parameters.

Used by actions: DescribeGeneralOTSpanList, DescribeGeneralSpanList, DescribeMetricRecords, DescribeServiceOverview, DescribeTagValues.

Name Type Required Description
Type String Yes Filtering method (=, !=, in).
Key String Yes Filter dimension name.
Value String Yes Filter value. uses commas to separate multiple values in 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: DescribeGeneralApmApplicationConfig.

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.

OrderBy

Sorting fields.

Used by actions: 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.

QueryMetricItem

Querying.

Used by actions: 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.

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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon