Data Types

Last updated: 2025-11-14 16:38:07

Data Types

Last updated: 2025-11-14 16:38:07

APMKV

APM floating-point number type key-value pair.

Used by actions: DescribeApmServiceMetric, DescribeMetricRecords, 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, DescribeApmSampleConfig, DescribeApmServiceMetric, DescribeMetricRecords, 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 convergence regular expression.
ExceptionFilter	String	Exception filtering regular expression.
ErrorCodeFilter	String	Error code filtering.
Components	String	Service component type.
UrlExclude	String	URL exclusion regular.
LogSource	String	Specifies the log source.
LogRegion	String	Log region.
IsRelatedLog	Integer	Whether logging is enabled. valid values: 0 (disabled), 1 (enabled).
LogTopicID	String	Log topic ID
IgnoreOperationName	String	API names to filter
LogSet	String	CLS log set/ES cluster ID
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 agent is enabled.
InstrumentList	Array of Instrument	Component List Note: This field may return null, indicating that no valid values can be obtained.
TraceSquash	Boolean	Whether link compression is enabled.
EventEnable	Boolean	Whether application diagnosis is enabled.
AgentOperationConfigView	AgentOperationConfigView	Related configurations of the probe APIs. Note: This field may return null, indicating that no valid values can be obtained.
EnableLogConfig	Boolean	Whether to enable application log configuration.
ServiceID	String	Application ID Note: This field may return null, indicating that no valid values can be obtained.
EnableDashboardConfig	Boolean	Whether to enable the dashboard configuration for applications. false: disabled (consistent with the business system configuration); true: enabled (application-level configuration). Note: This field may return null, indicating that no valid values can be obtained.
IsRelatedDashboard	Integer	Whether to associate with Dashboard. 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 to enable the application-level configuration. Note: This field may return null, indicating that no valid values can be obtained.
IsInstrumentationVulnerabilityScan	Integer	Whether to enable detection of component vulnerability. Note: This field may return null, indicating that no valid values can be obtained.
IsSqlInjectionAnalysis	Integer	Whether to enable SQL injection analysis. Note: This field may return null, indicating that no valid values can be obtained.
IsRemoteCommandExecutionAnalysis	Integer	Whether to enable execution analysis of remote command. Note: This field may return null, indicating that no valid values can be obtained.
IsMemoryHijackingAnalysis	Integer	Whether to enable detection analysis of Java webshell. 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. 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.) Note: This field may return null, indicating that no valid values can be obtained.
IsReadAnyFileAnalysis	Integer	Whether to enable the detection of reading arbitrary files. (0 - disabled; 1 - enabled.) Note: This field may return null, indicating that no valid values can be obtained.
IsUploadAnyFileAnalysis	Integer	Whether to enable the detection of uploading arbitrary files. (0 - disabled; 1 - enabled.) Note: This field may return null, indicating that no valid values can be obtained.
IsIncludeAnyFileAnalysis	Integer	Whether to enable the detection of the inclusion of arbitrary files. (0: disabled, 1: enabled.) Note: This field may return null, indicating that no valid values can be obtained.
IsDirectoryTraversalAnalysis	Integer	Whether to enable traversal detection of the directory. (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: disabled; 1: enabled.) Note: This field may return null, indicating that no valid values can be obtained.
IsScriptEngineInjectionAnalysis	Integer	Whether to enable script engine injection detection. (0 - disabled; 1 - enabled.) Note: This field may return null, indicating that no valid values can be obtained.
IsExpressionInjectionAnalysis	Integer	Whether to enable expression injection detection. (0 - disabled; 1 - enabled.) Note: This field may return null, indicating that no valid values can be obtained.
IsJNDIInjectionAnalysis	Integer	Whether to enable JNDI injection detection. (0 - disabled; 1 - enabled.) Note: This field may return null, indicating that no valid values can be obtained.
IsJNIInjectionAnalysis	Integer	Whether to enable JNI injection detection. (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 to enable deserialization detection. (0 - disabled; 1 - enabled). Note: This field may return null, indicating that no valid values can be obtained.
UrlAutoConvergenceEnable	Boolean	API name automatic convergence switch (0 - disabled; 1 - enabled)
UrlLongSegmentThreshold	Integer	Convergence threshold for URL long segments.
UrlNumberSegmentThreshold	Integer	Convergence threshold for URL numerical segments.
DisableMemoryUsed	Integer	Specifies the memory threshold for probe fusing.
DisableCpuUsed	Integer	Specifies the CPU threshold for probe fusing.

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).
DisableMemoryUsed	Integer	No	Specifies the memory threshold for probe fusing.
DisableCpuUsed	Integer	No	Specifies the CPU threshold for probe fusing.

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	Associated product instance ID. Note: This field may return null, indicating that no valid values can be obtained.
Status	Integer	Association status: 1 (enabled), 2 (disabled), 3 (invalid). Note: This field may return null, indicating that no valid values can be obtained.
Topic	String	Specifies the CKafka message topic.

ApmField

Metric dimension information.

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

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.

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, DescribeApmInstances, DescribeApmServiceMetric, 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: DescribeApmServiceMetric, 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: 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: 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.

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.

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