有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

APM

腾讯云应用性能管理服务参数

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh, ModifyTracingConfig。

名称 类型 必选 描述
Enable Boolean 是否启用
示例值:true
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-shanghai
InstanceId String APM 实例,如果创建时传入的参数为空,则表示自动创建 APM 实例。
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx

AccessLogConfig

AccessLog 配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh。

名称 类型 必选 描述
Enable Boolean 是否启用
示例值:true
Template String 采用的模板,可选值:istio(默认)、trace
示例值:istio
SelectedRange SelectedRange 选中的范围
CLS CLS 腾讯云日志服务相关参数
Encoding String 编码格式,可选值:TEXT、JSON
示例值:TEXT
Format String 日志格式
示例值:[%START_TIME%]
Address String GRPC第三方服务器地址
EnableServer Boolean 是否启用GRPC第三方服务器
示例值:true
EnableStdout Boolean 是否启用标准输出
示例值:true

ActiveOperation

正在执行的异步操作

被如下接口引用:DescribeMesh, DescribeMeshList。

名称 类型 描述
OperationId String 操作Id
Type String 操作类型,取值范围:
- LINK_CLUSTERS: 关联集群
- RELINK_CLUSTERS: 重新关联集群
- UNLINK_CLUSTERS: 解关联集群
- INSTALL_MESH: 安装网格

AutoInjectionNamespaceState

描述某一网格在特定命名空间下的自动注入状态

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Namespace String 命名空间名称
示例值:default
State String 注入状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:INJECT_NEW

CLS

腾讯云日志服务相关参数

被如下接口引用:CreateMesh, DescribeAccessLogConfig, DescribeMesh, DescribeMeshList, ModifyAccessLogConfig, ModifyMesh。

名称 类型 必选 描述
Enable Boolean 是否启用
示例值:true
LogSet String 日志集
示例值:mesh-xxx
Topic String 日志主题
示例值:accesslog
NeedDelete Boolean 是否删除
示例值:false
Region String cls 主题创建的地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:sh

Cluster

Mesh集群信息

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
ClusterId String 集群Id
示例值:cls-xxxxxxxx
Region String 地域
示例值:sh
Role String 集群角色,取值范围:
- MASTER:控制面所在的主集群
- REMOTE:主集群管理的远端集群
示例值:master
VpcId String 私有网络Id
示例值:vpc-xxxxxxxx
SubnetId String 子网Id
示例值:subnet-xxxxxxxx
DisplayName String 名称,只读
State String 状态,只读
示例值:deleted
LinkedTime Timestamp ISO8601 关联时间,只读
Config ClusterConfig 集群配置
Status ClusterStatus 详细状态,只读
Type String 类型,取值范围:
- TKE
- EKS
示例值:TKE
HostedNamespaces Array of String 集群关联的 Namespace 列表

ClusterConfig

集群配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
AutoInjectionNamespaceList Array of String 自动注入SideCar的NameSpace
IngressGatewayList Array of IngressGateway Ingress配置列表
EgressGatewayList Array of EgressGateway Egress配置列表
Istiod IstiodConfig Istiod配置
注意:此字段可能返回 null,表示取不到有效值。
DeployConfig DeployConfig 部署配置
AutoInjectionNamespaceStateList Array of AutoInjectionNamespaceState 自动注入命名空间状态列表

ClusterStatus

集群状态

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 描述
LinkState String 关联状态,取值范围:
- LINKING: 关联中
- LINKED: 已关联
- UNLINKING: 解关联中
- LINK_FAILED: 关联失败
- UNLINK_FAILED: 解关联失败
示例值:linking
LinkErrorDetail String 关联错误详情
注意:此字段可能返回 null,表示取不到有效值。

CrossRegionConfig

负载均衡跨域设置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述

CustomPromConfig

第三方 Prometheus 配置参数

被如下接口引用:LinkPrometheus。

名称 类型 必选 描述
Url String Prometheus 访问地址
示例值:http://x.x.x.x:909
AuthType String 认证方式
示例值:none, basic
IsPublicAddr Boolean 是否公网地址,缺省为 false
示例值:true
VpcId String 虚拟网络id
示例值:vpc-xxxxxxxx
Username String Prometheus 用户名(用于 basic 认证方式)
示例值:test
Password String Prometheus 密码(用于 basic 认证方式)
示例值:test

DeployConfig

部署配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
NodeSelectType String 部署类型,取值范围:
- SPECIFIC:专有模式
- AUTO:普通模式
示例值:AUTO
Nodes Array of String 指定的节点

EgressGateway

Egress配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Name String Egress名称
示例值:istio-egressgateway-xxx
Namespace String 所在的Namespace
示例值:default
Workload WorkloadConfig 工作负载配置
Status EgressGatewayStatus 工作负载的状态

EgressGatewayStatus

egress gateway 的状态

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 描述
CurrentVersion String egress gateway的当前版本
DesiredVersion String egress gateway的目标版本
State String egress gateway的状态,取值:running,upgrading,rollbacking

ExtensiveCluster

内网独占集群配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
ClusterId String Cluster ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:tgw-lgt20d75
Zone String 可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-5

ExtensiveClusters

内网独占集群配置列表

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
L4Clusters Array of ExtensiveCluster 4层集群配置
注意:此字段可能返回 null,表示取不到有效值。
L7Clusters Array of ExtensiveCluster 7层集群配置
注意:此字段可能返回 null,表示取不到有效值。

Filter

键值对过滤器,用于条件过滤查询。例如过滤ID、名称等

被如下接口引用:DescribeMeshList。

名称 类型 必选 描述
Name String 需要过滤的字段。
示例值:mesh-name
Values Array of String 字段的过滤值。

GrafanaInfo

Grafana信息

被如下接口引用:DescribeMesh, DescribeMeshList。

名称 类型 描述
Enabled Boolean 是否开启
示例值:true
InternalURL String 内网地址
PublicURL String 公网地址
注意:此字段可能返回 null,表示取不到有效值。
PublicFailedReason String 公网失败原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:TIMEOUT
PublicFailedMessage String 公网失败详细信息
注意:此字段可能返回 null,表示取不到有效值。

HorizontalPodAutoscalerSpec

HPA 配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
MinReplicas Integer 最小副本数
示例值:1
MaxReplicas Integer 最大副本数
示例值:3
Metrics Array of MetricSpec 用于计算副本数的指标

IngressGateway

IngressGateway 实例信息

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Name String IngressGateway 实例名字
示例值:istio-ingressgateway
Namespace String 命名空间
示例值:istio-system
ClusterId String 集群 ID
示例值:cls-xxxxxxxx
Service Service Service 配置
Workload WorkloadConfig Workload 配置
LoadBalancer LoadBalancer 负载均衡配置,自动创建 CLB 时返回
注意:此字段可能返回 null,表示取不到有效值。
Status IngressGatewayStatus IngressGateway 状态信息,只读
LoadBalancerId String 负载均衡实例ID,使用已有 CLB 时返回
示例值:lb-xxxxxxxx

IngressGatewayStatus

IngressGateway状态

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 描述
LoadBalancer LoadBalancerStatus 负载均衡实例状态
CurrentVersion String ingress gateway 当前的版本
DesiredVersion String ingress gateway 目标的版本
State String ingress gateway的状态,取值running, upgrading, rollbacking

InjectConfig

自动注入配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh。

名称 类型 必选 描述
ExcludeIPRanges Array of String 不需要进行代理的 ip 地址范围
注意:此字段可能返回 null,表示取不到有效值。
示例值:["10.0.1.0/24","10.0.2.0/24"]
HoldApplicationUntilProxyStarts Boolean 是否等待sidecar启动
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
HoldProxyUntilApplicationEnds Boolean 是否允许sidecar等待
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

IstioConfig

Istio配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh。

名称 类型 必选 描述
OutboundTrafficPolicy String 外部流量策略
示例值:ALLOW_ANY
Tracing TracingConfig 调用链配置(Deprecated,请使用 MeshConfig.Tracing 进行配置)
DisablePolicyChecks Boolean 禁用策略检查功能
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
EnablePilotHTTP Boolean 支持HTTP1.0协议
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
DisableHTTPRetry Boolean 禁用HTTP重试策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
SmartDNS SmartDNSConfig SmartDNS策略
注意:此字段可能返回 null,表示取不到有效值。

IstiodConfig

Istiod配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Workload WorkloadConfig 工作负载配置

LoadBalancer

负载均衡配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
LoadBalancerType String 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。
只读。
示例值:OPEN
SubnetId String 负载均衡实例所在的子网(仅对内网VPC型LB有意义),只读。
示例值:subnet-xxxxxxxx
InternetChargeType String TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费;只读。
示例值:TRAFFIC_POSTPAID_BY_HOUR
InternetMaxBandwidthOut Integer 最大出带宽,单位Mbps,仅对公网属性的LB生效,默认值 10
示例值:10
ZoneID String 可用区 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-shanghai
VipIsp String 运营商类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:GMCC
TgwGroupName String TGW Group 名
注意:此字段可能返回 null,表示取不到有效值。
示例值:ziyan_huiyi
AddressIPVersion String IP 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:IPv4
Tags Array of Tag 标签列表
注意:此字段可能返回 null,表示取不到有效值。
ExtensiveClusters ExtensiveClusters 内网独占集群配置列表
注意:此字段可能返回 null,表示取不到有效值。
CrossRegionConfig CrossRegionConfig 负载均衡跨地域配置
注意:此字段可能返回 null,表示取不到有效值。

LoadBalancerStatus

负载均衡状态信息

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 描述
LoadBalancerId String 负载均衡实例 ID
示例值:lb-xxxxxxxx
LoadBalancerName String 负载均衡实例名字
示例值:cls-xxxxxxxx_istio_igw
LoadBalancerVip String 负载均衡实例 VIP
示例值:x.x.x.x
LoadBalancerHostname String 负载均衡实例 Hostname
注意:此字段可能返回 null,表示取不到有效值。
示例值:lb-xxxxx-xxxx.clb.ap-shanghai.tencentclb.com

Mesh

Mesh信息

被如下接口引用:DescribeMesh, DescribeMeshList。

名称 类型 描述
MeshId String Mesh实例Id
示例值:mesh-xxxxxxxx
DisplayName String Mesh名称
Type String Mesh类型,取值范围:
- STANDALONE:独立网格
- HOSTED:托管网格
示例值:hosted
Region String 地域
示例值:sh
Version String 版本
示例值:1.8.1
State String Mesh状态,取值范围:
- PENDING:等待中
- CREATING:创建中
- RUNNING:运行中
- ABNORMAL:异常
- UPGRADING:升级中
- CANARY_UPGRADED:升级灰度完成
- ROLLBACKING:升级回滚
- DELETING:删除中
- CREATE_FAILED:安装失败
- DELETE_FAILED:删除失败
- UPGRADE_FAILED:升级失败
- ROLLBACK_FAILED:回滚失败
示例值:RUNNING
CreatedTime Timestamp 创建时间
UpdatedTime Timestamp 修改时间
注意:此字段可能返回 null,表示取不到有效值。
ClusterList Array of Cluster 集群列表
Config MeshConfig Mesh配置
Status MeshStatus Mesh详细状态
TagList Array of Tag 标签列表

MeshConfig

网格配置项

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh。

名称 类型 必选 描述
Istio IstioConfig Istio配置
AccessLog AccessLogConfig AccessLog配置
Prometheus PrometheusConfig Prometheus配置
Inject InjectConfig 自动注入配置
注意:此字段可能返回 null,表示取不到有效值。
Tracing TracingConfig 调用跟踪配置
注意:此字段可能返回 null,表示取不到有效值。
SidecarResources ResourceRequirements Sidecar自定义资源
注意:此字段可能返回 null,表示取不到有效值。

MeshStatus

Mesh当前状态

被如下接口引用:DescribeMesh, DescribeMeshList。

名称 类型 描述
ServiceCount Integer 服务数量
示例值:1
CanaryVersion String 灰度升级的版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.8.1
Prometheus Array of PrometheusStatus 已废弃
注意:此字段可能返回 null,表示取不到有效值。
StateMessage String 状态附带信息
注意:此字段可能返回 null,表示取不到有效值。
ActiveOperationList Array of ActiveOperation 正在执行的异步操作
注意:此字段可能返回 null,表示取不到有效值。
TPS PrometheusStatus 获取TPS信息
注意:此字段可能返回 null,表示取不到有效值。

MetricSpec

MetricSpec 描述如何通过指定指标进行自动扩缩容

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Type String 指标来源类型,支持 Pods/Resource
示例值:Pods
Pods PodsMetricSource 使用自定义指标扩进行自动扩缩容
Resource ResourceMetricSource 使用资源指标扩进行自动扩缩容

PodsMetricSource

PodsMetricSource 定义了如何根据特定指标进行扩缩容

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
MetricName String 指标名
示例值:k8s_pod_rate_cpu_core_used_request
TargetAverageValue String 目标值
示例值:80

PrometheusConfig

Prometheus 配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkPrometheus, ModifyMesh。

名称 类型 必选 描述
VpcId String 虚拟网络Id
示例值:vpc-xxxxxxxx
SubnetId String 子网Id
示例值:subnet-xxxxxxxx
Region String 地域
示例值:sh
InstanceId String 关联已存在实例Id,不填则默认创建
CustomProm CustomPromConfig 第三方 Prometheus
注意:此字段可能返回 null,表示取不到有效值。

PrometheusStatus

Prometheus状态信息

被如下接口引用:DescribeMesh, DescribeMeshList。

名称 类型 描述
PrometheusId String Prometheus Id
DisplayName String 展示名称
InstanceId String 实例Id
VpcId String 虚拟网络Id
State String 状态
Region String 地区
示例值:sh
Grafana GrafanaInfo Grafana信息
注意:此字段可能返回 null,表示取不到有效值。
Type String Prometheus 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:tmp

Resource

Resource 定义了资源类型和数量

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh。

名称 类型 必选 描述
Name String 资源类型 cpu/memory
示例值:cpu
Quantity String 资源数量
示例值:1

ResourceMetricSource

ResourceMetricSource 定义了如何根据已知类型的资源指标进行扩缩容

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Name String 资源名称 cpu/memory
示例值:cpu
TargetAverageUtilization Integer 目标平均利用率
示例值:60
TargetAverageValue String 目标平均值
示例值:60

ResourceRequirements

ResourceRequirements 描述了计算资源需求。

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Limits Array of Resource Limits 描述了允许的最大计算资源量。
Requests Array of Resource Requests 描述所需的最小计算资源量。

SelectedItems

选中的项目

被如下接口引用:DescribeAccessLogConfig, ModifyAccessLogConfig。

名称 类型 必选 描述
Namespace String 命名空间
示例值:ns
ClusterName String 集群名称
示例值:cls-test
ItemName String 选中项目名字
示例值:istio-proxy sidecar
Gateways Array of String ingress gw的名称列表
示例值:[gw-1,gw-2]

SelectedRange

被选中的范围

被如下接口引用:CreateMesh, DescribeAccessLogConfig, DescribeMesh, DescribeMeshList, ModifyAccessLogConfig, ModifyMesh。

名称 类型 必选 描述
Items Array of SelectedItems 选中的项目详细内容
All Boolean 是否全选
示例值:false

Service

Service信息

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Type String ClusterIP/NodePort/LoadBalancer
示例值:LoadBalancer
CLBDirectAccess Boolean 是否开启LB直通Pod
示例值:true
ExternalTrafficPolicy String 服务是否希望将外部流量路由到节点本地或集群范围的端点。 有两个可用选项:Cluster(默认)和 Local。Cluster 隐藏了客户端源 IP,可能导致第二跳到另一个节点;Local 保留客户端源 IP 并避免 LoadBalancer 和 NodePort 类型服务的第二跳。
示例值:Cluster

SmartDNSConfig

智能DNS配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh。

名称 类型 必选 描述
IstioMetaDNSCapture Boolean 开启DNS代理
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
IstioMetaDNSAutoAllocate Boolean 开启自动地址分配
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

Tag

标签

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Key String 标签键
示例值:k1
Value String 标签值
示例值:v1
Passthrough Boolean 是否透传给其他关联产品
示例值:true

TracingConfig

调用链配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh。

名称 类型 必选 描述
Sampling Float 调用链采样率,百分比
示例值:1.0
Enable Boolean 是否启用调用跟踪
示例值:true
APM APM 腾讯云 APM 服务相关参数
Zipkin TracingZipkin 启动第三方服务器的地址

TracingZipkin

调用追踪的Zipkin设置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, ModifyMesh, ModifyTracingConfig。

名称 类型 必选 描述
Address String Zipkin调用地址

WorkloadConfig

工作负载配置

被如下接口引用:CreateMesh, DescribeMesh, DescribeMeshList, LinkClusterList, ModifyMesh。

名称 类型 必选 描述
Replicas Integer 工作副本数
示例值:1
Resources ResourceRequirements 资源配置
HorizontalPodAutoscaler HorizontalPodAutoscalerSpec HPA策略
SelectedNodeList Array of String 部署到指定节点
DeployMode String 组件的部署模式,取值说明:
IN_GENERAL_NODE:常规节点
IN_EKLET:eklet 节点
IN_SHARED_NODE_POOL:共享节电池
IN_EXCLUSIVE_NODE_POOL:独占节点池
示例值:IN_GENERAL_NODE


http://www.vxiaotou.com