API 参考

Instana 的 API 参考

程序包

instana.io/v1beta2

软件包 v1beta2 包含 v1beta2 API 组的 API 模式定义

资源类型

承兑人

接受者包含接受者监听器的配置（主机名和端口）。

显示位置：

字段 描述 缺省值 验证
agent HostPortWithName 代理接收器的主机和端口
eum HostPortWithName 最终用户监控接收器（EUM）的主机和端口
synthetics HostPortWithName 合成材料接收器的主机和端口
serverless HostPortWithName 无服务器接收器（EUM）的主机和端口
otlp OTLPA 接收器 开放式遥测接收器的配置

AutoscalingConfig

显示位置：

字段 描述 缺省值 验证
disabled 布尔 禁用该组件的自动缩放功能
minReplicas 整数 自动分级器开始分级的最小副本数，默认为 1。
maxReplicas 整数 自动平衡器可扩展的副本数量上限，默认值基于 ResourceProfile。
metrics MetricSpec 矩阵 度量包含用于计算
期望副本数的规格（将使用所有度量的最大副本数
）
如果未设置，默认度量将设置为平均 CPU 利用率的 150%。
behavior HorizontalPodAutoscalerBehavior 行为配置目标
在向上和向下两个方向上的缩放行为（分别为 scaleUp 和 scaleDown 字段）。
如果未设置，则使用 HPAScalingRules 默认的向上和向下缩放。		 可选： {}

BeeInstanaConfig

显示位置：

字段 描述 缺省值 验证
hosts 字符串数组 用于连接数据存储的主机列表。
对于 ClickHouse 群集，条目必须按正确顺序分片。		 MinItems: 1
ports NamedPorts 用于连接数据存储的已命名端口列表。
如果省略，则使用默认端口。
properties 属性 数据存储器的可选属性。
authEnabled 布尔 对数据存储器启用认证。 凭证应配置在核心命名空间中与相应核心同名的秘密
中。
clustered 布尔 对于 BeeInstana 操作员群集，其值必须是 true 是

CassandraConfig

显示位置：

字段 描述 缺省值 验证
hosts 字符串数组 用于连接数据存储的主机列表。
对于 ClickHouse 群集，条目必须以正确的顺序分片。		 MinItems: 1
ports NamedPorts 用于连接数据存储的已命名端口列表。
如果省略，则使用默认端口。
properties 属性 数据存储器的可选属性。
authEnabled 布尔 对数据存储器启用认证。 凭证应配置在核心命名空间中与相应核心同名的秘密
中。
keyspaces 字符串数组
datacenter 字符串 cassandra
replicationFactor 整数 1 最少1

CircuitBreakers

显示位置：

字段 描述 缺省值 验证
maxConnections 整数 允许连接上游群集的最大连接数。
maxPendingRequests 整数 上游群集允许的最大待处理请求数。
maxRequests 整数 上游群集允许的最大并行请求数。
maxRetries 整数 上游群集允许的最大并行重试次数。

ClickhouseConfig

显示位置：

字段 描述 缺省值 验证
hosts 字符串数组 用于连接数据存储的主机列表。
对于 ClickHouse 群集，条目必须按正确顺序分片。		 MinItems: 1
ports NamedPorts 用于连接数据存储的已命名端口列表。
如果省略，则使用默认端口。
properties 属性 数据存储器的可选属性。
authEnabled 布尔 对数据存储器启用认证。 凭证应配置在核心命名空间中与相应核心同名的秘密
中。
schemas 字符串数组
clusterName 字符串 本地

ComponentConfig

“组件配置”允许对特定组件进行其他配置。

显示位置：

字段 描述 缺省值 验证
name 字符串 组件的名称。
disabled 布尔 禁用组件。
imageTag 字符串 覆盖组件的 Docker 映像标记。
replicas 整数 所需副本数。 如果未设置，那么将缺省 1。
env 环境 要在容器中设置的其他环境变量的列表。
resources ResourceRequirements 该组件所需的计算资源。
如果省略，操作员将根据配置文件应用合理的默认值。
autoscalingConfig AutoscalingConfig 每个组件的自动缩放配置，否则适用标准行为。
affinity 亲缘关系 亲缘关系调度规则组。
nodeSelector 对象（键：字符串，值：字符串） 必须与节点的标签匹配才能在该节点上调度 pod 的选择器。
tolerations 容忍度数组 通过使用匹配运算符 operator ，该容忍度所连接的 pod 可以容忍与
三重 key,value,effect 匹配的任何污点。
priorityClassName 字符串 为该组件配置优先级类。
properties 属性 配置组件配置属性。

ComponentConfigs

底层类型: ComponentConfig

显示位置：

字段 描述 缺省值 验证
name 字符串 组件的名称。
disabled 布尔 禁用组件。
imageTag 字符串 覆盖组件的 Docker 映像标记。
replicas 整数 所需副本数。 如果未设置，那么将缺省 1。
env 环境 要在容器中设置的其他环境变量的列表。
resources ResourceRequirements 该组件所需的计算资源。
如果省略，操作员将根据配置文件应用合理的默认值。
autoscalingConfig AutoscalingConfig 每个组件的自动缩放配置，否则适用标准行为。
affinity 亲缘关系 亲缘关系调度规则组。
nodeSelector 对象（键：字符串，值：字符串） 必须与节点的标签匹配才能在该节点上调度 pod 的选择器。
tolerations 容忍度数组 通过使用匹配运算符 operator ，该容忍度所连接的 pod 可以容忍与
三重 key,value,effect 匹配的任何污点。
priorityClassName 字符串 为该组件配置优先级类。
properties 属性 配置组件配置属性。

控制器

显示位置：

字段 描述 缺省值 验证
imageConfig ImageConfig 网关控制器镜像的镜像配置
replicas 整数 网关控制器副本数量
tlsCipherSuites 字符串数组 要使用的 TLS 密码套件列表。 'disableTls' 为 true 时忽略
config DeploymentConfig 定义网关控制器部署的配置。

内核

核心是核心 API 的模式。

显示位置：

字段 描述 缺省值 验证
apiVersion 字符串 instana.io/v1beta2
kind 字符串 Core
metadata ObjectMeta 请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec CoreSpec CoreSpec 指定 Instana 核心的配置。

CoreList

CoreList 包含核心列表。

字段 描述 缺省值 验证
apiVersion 字符串 instana.io/v1beta2
kind 字符串 CoreList
metadata ListMeta 请参阅 Kubernetes API 文档以了解 metadata 的字段。
items Core 阵列

CoreSpec

CoreSpec 定义核心的期望状态。

显示位置：

字段 描述 缺省值 验证
imageConfig ImageConfig Docker
只需设置应覆盖的字段（如标签）。
imagePullPolicy PullPolicy 图像拉取策略。
始终、从不、 IfNotPresent 之一。
如果指定了 :latest 标记，默认为始终，否则为 IfNotPresent。
imagePullSecrets LocalObjectReference 数组 ImagePullSecrets 是一个可选列表，包含用于提取图像的秘密引用。 指定的秘密必须存在于 core 和单元命名空间中。
serviceAccountAnnotations 对象（键：字符串，值：字符串） ServiceAccount
可用于在 EKS 上分配 IAM 角色等。
priorityClassName 字符串 为操作程序创建的所有 pod 配置全局优先级类。
baseDomain 字符串 Instana 的基本域。
domains 领域 请勿使用：为基域和接受域配置域。
acceptors 承兑人 配置所有接收器的域和端口。
gatewayConfig GatewayConfig 网关组件的配置
autoscalingEnabled 布尔 测试版（请在代表性测试集群中检查行为。）
可为 Instana 后端组件创建 HorizontalPodAutoscaling 资源，以便对 ComponentConfig 中的 AutoscalingConfig 进行进一步配置。
resourceProfile ResourceProfile 要使用的资源概要文件。 medium 枚举：[演示 小 中 大］
storageConfigs StorageConfigs 所有外部存储器的配置。 配置应存储每个组件的外部存储器的位置。
heapDumpsPVC PersistentVolumeClaimSpec 配置用于存储 JVM 堆转储的 PVC。 如果没有配置，堆转储将被写入
，挂载在 OufOfMemoryError 上的 emptyDir 中。 卷必须支持 ReadWriteMany 访问权。
datastoreConfigs DatastoreConfigs DatastoreConfigs 配置数据存储器连接信息。
componentConfigs ComponentConfigs ComponentConfigs 覆盖组件缺省配置。
deploymentStrategyType DeploymentStrategyType 组件部署的部署策略类型 (缺省值: RollingUpdate) RollingUpdate 枚举：[ RollingUpdate Recreate]
可选：{}.
emailConfig EmailConfig 用于通过 Amazon SES 或 SMTP 服务器发送电子邮件的配置。
serviceProviderConfig ServiceProviderConfig SAML 或 OIDC 的服务提供者配置。
proxyConfig ProxyConfig ProxyConfig 配置。
geoDbUrl 字符串 下载 GeoLite2 地理定位数据文件的 URL。
agentAcceptorConfig HostPort 代理程序接受器的主机和端口。
featureFlags FeatureFlags 配置全局功能标志。
env 环境 配置全局环境变量。
properties 属性 配置全局组件配置属性。
nodeSelector 对象（键：字符串，值：字符串） 选择器，必须与节点的标签匹配才能在该节点上调度 pod。
tolerations 容忍度数组 通过使用匹配运算符 operator ，该容忍度所连接的 pod 可以容忍与
三重 key,value,effect 匹配的任何污点。
operationMode OperationMode 操作员操作方式。 正常 "或 "维护 "中的一个（默认为 "正常"）。
如果设置为 "维护"，部署将缩减为零。		 正常 枚举：[正常维护]
operationScopes OperationScope 数组 定义要部署的作用域的组件。 仅适用于SaaS-like部署方案。 [全球核心] 枚举：[核心全局]

DatastoreConfig

显示位置：

字段 描述 缺省值 验证
hosts 字符串数组 用于连接数据存储的主机列表。
对于 ClickHouse 群集，条目必须按正确顺序分片。		 MinItems: 1
ports NamedPorts 用于连接数据存储的已命名端口列表。
如果省略，则使用默认端口。
properties 属性 数据存储器的可选属性。
authEnabled 布尔 对数据存储器启用认证。 凭证应配置在核心命名空间中与相应核心同名的秘密
中。

DatastoreConfigs

显示位置：

字段 描述 缺省值 验证
cassandraConfigs CassandraConfig 数组
clickhouseConfigs ClickhouseConfig 数组
elasticsearchConfig ElasticsearchConfig
kafkaConfig KafkaConfig
beeInstanaConfig BeeInstanaConfig
postgresConfigs PostgresConfig 数组

DeploymentConfig

DeploymentConfig 定义组件部署的配置。

显示位置：

字段 描述 缺省值 验证
envs 环境 环境变量
resources ResourceRequirements 该组件所需的计算资源。
如果省略，操作员将根据配置文件应用合理的默认值。
affinity 亲缘关系 亲缘关系调度规则组。
nodeSelector 对象（键：字符串，值：字符串） 必须与节点的标签匹配才能在该节点上调度 pod 的选择器。
tolerations 容忍度数组 通过使用匹配运算符 operator ，该容忍度所连接的 pod 可以容忍与
三重 key,value,effect 匹配的任何污点。
priorityClassName 字符串 为该组件配置优先级类。

域

请勿使用：域定义了基域以及代理和 OTLP 接受器的 FQDNs

显示位置：

字段 描述 缺省值 验证
base 字符串 请勿使用：基域的 FQDN
agentAcceptor 字符串 切勿使用：代理接收器的 FQDN
otlpHttp 字符串 请勿使用：开放式遥测接收器的 FQDN ( HTTP )
otlpGrpc 字符串 请勿使用：开放式遥测接收器的 FQDN ( gRPC )

ElasticsearchConfig

显示位置：

字段 描述 缺省值 验证
hosts 字符串数组 用于连接数据存储的主机列表。
对于 ClickHouse 群集，条目必须按正确顺序分片。		 MinItems: 1
ports NamedPorts 用于连接数据存储的已命名端口列表。
如果省略，则使用默认端口。
properties 属性 数据存储器的可选属性。
authEnabled 布尔 对数据存储器启用认证。 凭证应配置在核心命名空间中与相应核心同名的秘密
中。
clusterName 字符串 本地部署_本地部署
defaultIndexShards 整数 5
defaultIndexReplicas 整数 0
defaultIndexRoutingPartitionSize 整数 2
indexConfigs IndexConfig 数组

EmailConfig

EmailConfig 是电子邮件的配置。

显示位置：

字段 描述 缺省值 验证
smtpConfig SMTPConfig 配置 SMTP 服务器以发送电子邮件。
sesConfig SESConfig 配置 Amazon 简单电子邮件服务以发送电子邮件。

env

底层类型: struct{Name string "json:"name""; Value string "json:"value,omitempty""}

环境变量配置。

显示位置：

EnvoyLogLevel

底层类型: 字符串

显示位置：

字段 描述
off
debug
info
error

环境

底层类型: Env

显示位置：

FeatureFlag

FeatureFlag 标志配置。

显示位置：

字段 描述 缺省值 验证
name 字符串 功能部件标志的名称。
enabled 布尔 切换功能部件标志。

FeatureFlags

底层类型: FeatureFlag

显示位置：

字段 描述 缺省值 验证
name 字符串 功能部件标志的名称。
enabled 布尔 切换功能部件标志。

GCloudConfig

底层类型: 结构{Bucket string "json:"bucket""; Prefix string "json:"prefix""; StorageClass string "json:"storageClass""; BucketLongTerm string "json:"bucketLongTerm,omitempty""; PrefixLongTerm string "json:"prefixLongTerm,omitempty""; StorageClassLongTerm string "json:"storageClassLongTerm,omitempty""; ServiceAccountKey string "json:"-" yaml:"serviceAccountKey""}

GCloudConfig 配置。

显示位置：

网关

显示位置：

字段 描述 缺省值 验证
imageConfig ImageConfig 网关映像的映像配置
replicas 整数 网关副本数量
logLevel EnvoyLogLevel 设置网关的日志级别 错误 枚举：[调试信息错误关闭]
adminListener 字符串 为网关管理端点配置监听器 IP 127.0.0.1
circuitBreakers CircuitBreakers 为网关接收器入口流量配置断路器值。
config DeploymentConfig 定义网关部署的配置。
loadBalancerConfig LoadBalancerConfig LoadBalancer 网关的配置。

GatewayConfig

GatewayControllerConfig 包含网关组件的配置。

显示位置：

字段 描述 缺省值 验证
enabled 布尔 启用网关组件的特殊处理
disableTLS 布尔 禁用 TLS 终止 否
gateway 网关 网关组件的配置
controller 控制器 网关控制器组件的配置

HostPort

HostPort 保存主机和端口组合。

显示位置：

字段 描述 缺省值 验证
host 字符串 主机名或 IP 地址。
port 整数 端口。

HostPortWithName

HostPortWithName 持有主机和端口组合以及名称。

显示位置：

字段 描述 缺省值 验证
host 字符串 主机名或 IP 地址。
port 整数 端口号。

ImageConfig

ImageConfig 用于配置组件的 Docker 映像。

显示位置：

字段 描述 缺省值 验证
registry 字符串 要使用的 Docker 注册表。 缺省为 "artifact-public.instana.io"。
repository 字符串 到注册表中映像的路径。 默认为 "backend"。
运算符在计算完整图像标记时会自动附加组件名称。
tag 字符串 要使用的映像版本。 每个操作员版本都有一个默认版本，当该字段为空时，
。

IndexConfig

显示位置：

字段 描述 缺省值 验证
name 字符串
shards 整数
replicas 整数
routingPartitionSize 整数

KafkaConfig

显示位置：

字段 描述 缺省值 验证
hosts 字符串数组 用于连接数据存储的主机列表。
对于 ClickHouse 群集，条目必须按正确顺序分片。		 MinItems: 1
ports NamedPorts 用于连接数据存储的已命名端口列表。
如果省略，则使用默认端口。
properties 属性 数据存储器的可选属性。
authEnabled 布尔 对数据存储器启用认证。 凭证应配置在核心命名空间中与相应核心同名的秘密
中。
replicationFactor 整数 1 最少1
saslMechanism 字符串 客户机用于向代理进行认证的 SASL 机制。 可能的值为 PLAIN ， SCRAM-SHA-256和 SCRAM-SHA-512。 PLAIN

LoadBalancerConfig

显示位置：

字段 描述 缺省值 验证
enabled 布尔 启用创建负载平衡器。 否
ip 字符串 为负载平衡器配置外部 IP。 MaxLength: 253 图案：
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
externalTrafficPolicy ServiceExternalTrafficPolicy 为负载平衡器设置外部流量策略。 本地
annotations 设置 为负载平衡器配置注释。

NamedPorts

基础类型： NamedPort

显示位置：

OTLPA 接收器

显示位置：

字段 描述 缺省值 验证
http HostPortWithName 开放式遥测接收器（ HTTP 终端）的主机和端口
grpc HostPortWithName 开放式遥测接收器（ gRPC 终端）的主机和端口

OperationMode

底层类型: 字符串

显示位置：

字段 描述
normal
maintenance

OperationScope

底层类型: 字符串

验证：

  • 枚举：[核心全局]

显示位置：

字段 描述
global
core

PostgresConfig

显示位置：

字段 描述 缺省值 验证
hosts 字符串数组 用于连接数据存储的主机列表。
对于 ClickHouse 群集，条目必须按正确顺序分片。		 MinItems: 1
ports NamedPorts 用于连接数据存储的已命名端口列表。
如果省略，则使用默认端口。
properties 属性 数据存储器的可选属性。
authEnabled 布尔 对数据存储器启用认证。 凭证应配置在核心命名空间中与相应核心同名的秘密
中。
databases 字符串数组

属性

基础类型： 物业

显示位置：

ProxyConfig

显示位置：

字段 描述 缺省值 验证
host 字符串 主机名或 IP 地址。
port 整数 端口。
nonProxyHosts 字符串数组

ResourceProfile

底层类型: 字符串

ResourceProfile 表示保存概要文件名称的类型。

显示位置：

S3Config

基础类型： 结构 {Endpoint string "json:"endpoint""; Region string "json:"region""; Bucket string "json:"bucket""; Prefix string "json:"prefix""; StorageClass string "json:"storageClass""; BucketLongTerm string "json:"bucketLongTerm,omitempty""; PrefixLongTerm string "json:"prefixLongTerm,omitempty""; StorageClassLongTerm string "json:"storageClassLongTerm,omitempty""; ForcePathStyle bool "json:"forcePathStyle,omitempty""; AccessKeyId string "json:"-" yaml:"accessKeyId""; SecretAccessKey string "json:"-" yaml:"secretAccessKey""}

S3Config 配置。

显示位置：

SES配置

SESConfig 配置 Amazon Simple Email Service 以发送电子邮件。

显示位置：

字段 描述 缺省值 验证
from 字符串 发件人电子邮件地址。
returnPath 字符串 返回路径。
region 字符串 AWS 区域。

SMTP配置

SMTPConfig 配置 SMTP 服务器以发送电子邮件。

显示位置：

字段 描述 缺省值 验证
from 字符串 发件人电子邮件地址。
host 字符串 SMTP 服务器的主机名。
port 整数 SMTP 服务器的端口。
useSSL 布尔 如果设置为 true，那么 useSSL 将启用 SSL。 否
startTLS 布尔 如果设置为 true，那么 startTLS 将启用 StartTLS。 否
check_server_identity 布尔 如果设置为 true，那么 CheckServerIdentity 将启用服务器身份验证。 否

ServiceProviderConfig

显示位置：

字段 描述 缺省值 验证
basePath 字符串 基本 URL（缺省值为 "/auth"）。 /认证 图案 ^\/.*
maxIDPMetadataSizeInBytes 整数 最大 IDP 元数据大小（缺省值为 200000）。 200,000 美元
maxAuthenticationLifetimeSeconds 整数 最大认证生存期（缺省值为 604800）。 604800

状态

底层类型: 字符串

Instana 状态。

显示位置：

  • ResourceStatus
字段 描述
Ready
Error
Progressing
Maintenance

StorageConfig

显示位置：

字段 描述 缺省值 验证
pvcConfig PersistentVolumeClaimSpec 为外部存储配置 PersistentVolumeClaim。
卷必须支持 ReadWriteMany 访问。
s3Config S3Config 为外部存储器配置 S3 (或兼容)。
gcloudConfig GCloudConfig 为外部存储器配置 Google Cloud Storage 。

StorageConfigs

外部存储器 (PVC ， S3和 GCloud 存储区) 的配置

显示位置：

字段 描述 缺省值 验证
rawSpans StorageConfig 原始存储器的配置跨外部存储器。 配置应存储原始范围的位置。
synthetics StorageConfig 用于合成外部存储器的配置。 配置应存储合成测试结果的位置。
syntheticsKeystore StorageConfig Synthetics 外部存储器的配置。 配置 Synthetics 存储凭证的位置。
eumSourceMaps StorageConfig EUM 外部存储器的配置。 配置应存储 EUM 源映射的位置。
butlerKeystore StorageConfig 巴特勒外部存储器的配置。

单元

“单元”是单元 API 的模式。

显示位置：

字段 描述 缺省值 验证
apiVersion 字符串 instana.io/v1beta2
kind 字符串 Unit
metadata ObjectMeta 请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec UnitSpec

UnitList

UnitList 包含一个单元列表。

字段 描述 缺省值 验证
apiVersion 字符串 instana.io/v1beta2
kind 字符串 UnitList
metadata ListMeta 请参阅 Kubernetes API 文档以了解 metadata 的字段。
items 单元 阵列

UnitSpec

UnitSpec 定义单元的期望状态

显示位置：

字段 描述 缺省值 验证
coreName 字符串 核心的名称。
coreNamespace 字符串 核心组件所在的名称空间。
unitName 字符串 租户单元的名称。 MaxLength: 13 图案：
^[a-z][a-z0-9]*$
tenantName 字符串 租户的名称。 MaxLength: 15 图案：
^[a-z][a-z0-9]*$
resourceProfile ResourceProfile 要使用的资源概要文件。 medium 枚举：[演示 小 中 大］
heapDumpsPVC PersistentVolumeClaimSpec 配置用于存储 JVM 堆转储的 PVC。 如果没有配置，堆转储将被写入
，挂载在 OufOfMemoryError 上的 emptyDir 中。 卷必须支持 ReadWriteMany 访问权。
env 环境 配置全局环境变量。
componentConfigs ComponentConfigs ComponentConfigs 覆盖组件缺省配置。
priorityClassName 字符串
覆盖核心层配置的优先级。
properties 属性 配置组件配置属性。
nodeSelector 对象（键：字符串，值：字符串） 选择器，该选择器必须与节点的标签相匹配，才能在该节点上调度 pod。
可覆盖在核心级别上配置的节点选择器。
tolerations 容忍度数组 通过使用匹配运算符 operator ，该容忍度所连接的 pod 可容忍与
三重 key,value,effect 匹配的任何污点。
可覆盖在核心级别上配置的容忍度。
operationMode OperationMode 单元操作方式。 正常 "或 "维护 "中的一个（默认为 "正常"）。
如果设置为 "维护"，部署将缩减为零。		 正常 枚举：[正常维护]