{ "name": "tcm", "display_name": "服务网格", "description": "", "domain": "other", "api_version": "2021-04-13", "endpoint": "tcm.tencentcloudapi.com", "actions": [ { "name": "CreateMesh", "description": "创建网格", "status": "online", "parameters": [ { "name": "DisplayName", "type": "string", "required": true, "description": "Mesh名称", "example": "service-mgr" }, { "name": "MeshVersion", "type": "string", "required": true, "description": "Mesh版本", "example": "1.8.1" }, { "name": "Type", "type": "string", "required": true, "description": "Mesh类型，取值范围： - HOSTED：托管网格", "example": "HOSTED" }, { "name": "Config", "type": "object", "required": true, "description": "Mesh配置", "example": "无", "children": [ { "name": "Istio", "type": "object", "required": false, "description": "Istio配置", "example": "无", "children": [ { "name": "OutboundTrafficPolicy", "type": "string", "required": true, "description": "外部流量策略", "example": "ALLOW_ANY" }, { "name": "Tracing", "type": "object", "required": false, "description": "调用链配置（Deprecated，请使用 MeshConfig.Tracing 进行配置）", "example": "无", "children": [ { "name": "Sampling", "type": "float", "required": false, "description": "调用链采样率，百分比", "example": "1.0" }, { "name": "Enable", "type": "boolean", "required": false, "description": "是否启用调用跟踪", "example": "true" }, { "name": "APM", "type": "object", "required": false, "description": "腾讯云 APM 服务相关参数", "example": "无" }, { "name": "Zipkin", "type": "object", "required": false, "description": "启动第三方服务器的地址", "example": "无" } ] }, { "name": "DisablePolicyChecks", "type": "boolean", "required": false, "description": "禁用策略检查功能 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "EnablePilotHTTP", "type": "boolean", "required": false, "description": "支持HTTP1.0协议 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "DisableHTTPRetry", "type": "boolean", "required": false, "description": "禁用HTTP重试策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SmartDNS", "type": "object", "required": false, "description": "SmartDNS策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "IstioMetaDNSCapture", "type": "boolean", "required": false, "description": "开启DNS代理 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "IstioMetaDNSAutoAllocate", "type": "boolean", "required": false, "description": "开启自动地址分配 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] } ] }, { "name": "AccessLog", "type": "object", "required": false, "description": "AccessLog配置", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "Template", "type": "string", "required": false, "description": "采用的模板，可选值：istio（默认）、trace", "example": "istio" }, { "name": "SelectedRange", "type": "object", "required": false, "description": "选中的范围", "example": "无", "children": [ { "name": "Items", "type": "array", "required": false, "description": "选中的项目详细内容", "example": "无", "item_type": "string" }, { "name": "All", "type": "boolean", "required": false, "description": "是否全选", "example": "false" } ] }, { "name": "CLS", "type": "object", "required": false, "description": "腾讯云日志服务相关参数", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否启用", "example": "true" }, { "name": "LogSet", "type": "string", "required": false, "description": "日志集", "example": "mesh-xxx" }, { "name": "Topic", "type": "string", "required": false, "description": "日志主题", "example": "accesslog" }, { "name": "NeedDelete", "type": "boolean", "required": false, "description": "是否删除", "example": "false" }, { "name": "Region", "type": "string", "required": false, "description": "cls 主题创建的地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh" } ] }, { "name": "Encoding", "type": "string", "required": false, "description": "编码格式，可选值：TEXT、JSON", "example": "TEXT" }, { "name": "Format", "type": "string", "required": false, "description": "日志格式", "example": "[%START_TIME%]" }, { "name": "Address", "type": "string", "required": false, "description": "GRPC第三方服务器地址", "example": "172.0.3.6:80" }, { "name": "EnableServer", "type": "boolean", "required": false, "description": "是否启用GRPC第三方服务器", "example": "true" }, { "name": "EnableStdout", "type": "boolean", "required": false, "description": "是否启用标准输出", "example": "true" } ] }, { "name": "Prometheus", "type": "object", "required": false, "description": "Prometheus配置", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "虚拟网络Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网Id", "example": "subnet-xxxxxxxx" }, { "name": "Region", "type": "string", "required": false, "description": "地域", "example": "sh" }, { "name": "InstanceId", "type": "string", "required": false, "description": "关联已存在实例Id，不填则默认创建", "example": "prom-86rajg7s" }, { "name": "CustomProm", "type": "object", "required": false, "description": "第三方 Prometheus 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "Prometheus 访问地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "http://x.x.x.x:909" }, { "name": "AuthType", "type": "string", "required": true, "description": "认证方式 注意：此字段可能返回 null，表示取不到有效值。", "example": "none, basic" }, { "name": "IsPublicAddr", "type": "boolean", "required": false, "description": "是否公网地址，缺省为 false 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "VpcId", "type": "string", "required": false, "description": "虚拟网络id 注意：此字段可能返回 null，表示取不到有效值。", "example": "vpc-xxxxxxxx" }, { "name": "Username", "type": "string", "required": false, "description": "Prometheus 用户名（用于 basic 认证方式） 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "Prometheus 密码（用于 basic 认证方式） 注意：此字段可能返回 null，表示取不到有效值。", "example": "password" } ] } ] }, { "name": "Inject", "type": "object", "required": false, "description": "自动注入配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExcludeIPRanges", "type": "array", "required": false, "description": "不需要进行代理的 ip 地址范围 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"10.0.1.0/24\",\"10.0.2.0/24\"]", "item_type": "string" }, { "name": "HoldApplicationUntilProxyStarts", "type": "boolean", "required": false, "description": "是否等待sidecar启动 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "HoldProxyUntilApplicationEnds", "type": "boolean", "required": false, "description": "是否允许sidecar等待 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "Tracing", "type": "object", "required": false, "description": "调用跟踪配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Sampling", "type": "float", "required": false, "description": "调用链采样率，百分比", "example": "1.0" }, { "name": "Enable", "type": "boolean", "required": false, "description": "是否启用调用跟踪", "example": "true" }, { "name": "APM", "type": "object", "required": false, "description": "腾讯云 APM 服务相关参数", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否启用", "example": "true" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-shanghai" }, { "name": "InstanceId", "type": "string", "required": false, "description": "APM 实例，如果创建时传入的参数为空，则表示自动创建 APM 实例。 注意：此字段可能返回 null，表示取不到有效值。", "example": "apm-LmCpqBQaq" }, { "name": "NeedDelete", "type": "boolean", "required": false, "description": "是否要删除APM实例 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "Zipkin", "type": "object", "required": false, "description": "启动第三方服务器的地址", "example": "无", "children": [ { "name": "Address", "type": "string", "required": true, "description": "Zipkin调用地址", "example": "http://10.0.0.2" } ] } ] }, { "name": "SidecarResources", "type": "object", "required": false, "description": "Sidecar自定义资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Limits", "type": "array", "required": false, "description": "Limits 描述了允许的最大计算资源量。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "资源类型 cpu/memory", "example": "cpu" }, { "name": "Quantity", "type": "string", "required": false, "description": "资源数量", "example": "1" } ] }, { "name": "Requests", "type": "array", "required": false, "description": "Requests 描述所需的最小计算资源量。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "资源类型 cpu/memory", "example": "cpu" }, { "name": "Quantity", "type": "string", "required": false, "description": "资源数量", "example": "1" } ] } ] } ] }, { "name": "ClusterList", "type": "array", "required": false, "description": "关联集群", "example": "无", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id", "example": "cls-i3wbzkfl" }, { "name": "Region", "type": "string", "required": true, "description": "地域", "example": "ap-shanghai" }, { "name": "Role", "type": "string", "required": true, "description": "集群角色，取值范围： - MASTER：控制面所在的主集群 - REMOTE：主集群管理的远端集群", "example": "REMOTE" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网Id", "example": "subnet-xxxxxxxx" }, { "name": "DisplayName", "type": "string", "required": false, "description": "名称，只读", "example": "cluster-test" }, { "name": "State", "type": "string", "required": false, "description": "状态，只读", "example": "RUNNING" }, { "name": "LinkedTime", "type": "string", "required": false, "description": "关联时间，只读", "example": "2025-01-02T10:51:48.338+08:00" }, { "name": "Config", "type": "object", "required": false, "description": "集群配置", "example": "无", "children": [ { "name": "AutoInjectionNamespaceList", "type": "array", "required": true, "description": "自动注入SideCar的NameSpace", "example": "{\"ns1\",\"ns2\"}", "item_type": "string" }, { "name": "IngressGatewayList", "type": "array", "required": false, "description": "Ingress配置列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "IngressGateway 实例名字", "example": "istio-ingressgateway" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "istio-system" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群 ID", "example": "cls-xxxxxxxx" }, { "name": "Service", "type": "object", "required": true, "description": "Service 配置", "example": "无" }, { "name": "Workload", "type": "object", "required": true, "description": "Workload 配置", "example": "无" }, { "name": "LoadBalancer", "type": "object", "required": false, "description": "负载均衡配置，自动创建 CLB 时返回 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Status", "type": "object", "required": false, "description": "IngressGateway 状态信息，只读", "example": "无" }, { "name": "LoadBalancerId", "type": "string", "required": false, "description": "负载均衡实例ID，使用已有 CLB 时返回", "example": "lb-xxxxxxxx" } ] }, { "name": "EgressGatewayList", "type": "array", "required": false, "description": "Egress配置列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "Egress名称", "example": "istio-egressgateway-xxx" }, { "name": "Namespace", "type": "string", "required": true, "description": "所在的Namespace", "example": "default" }, { "name": "Workload", "type": "object", "required": false, "description": "工作负载配置", "example": "无" }, { "name": "Status", "type": "object", "required": false, "description": "工作负载的状态", "example": "无" } ] }, { "name": "Istiod", "type": "object", "required": false, "description": "Istiod配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Workload", "type": "object", "required": false, "description": "工作负载配置", "example": "无" } ] }, { "name": "DeployConfig", "type": "object", "required": false, "description": "部署配置", "example": "无", "children": [ { "name": "NodeSelectType", "type": "string", "required": false, "description": "部署类型，取值范围： - SPECIFIC：专有模式 - AUTO：普通模式", "example": "AUTO" }, { "name": "Nodes", "type": "array", "required": false, "description": "指定的节点", "example": "{\"10.0.0.2\", \"10,0,0,5\"}", "item_type": "string" } ] }, { "name": "AutoInjectionNamespaceStateList", "type": "array", "required": false, "description": "自动注入命名空间状态列表", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "default" }, { "name": "State", "type": "string", "required": false, "description": "注入状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "INJECT_NEW" } ] } ] }, { "name": "Status", "type": "object", "required": false, "description": "详细状态，只读", "example": "无", "children": [ { "name": "LinkState", "type": "string", "required": true, "description": "关联状态，取值范围： - LINKING: 关联中 - LINKED: 已关联 - UNLINKING: 解关联中 - LINK_FAILED: 关联失败 - UNLINK_FAILED: 解关联失败", "example": "linking" }, { "name": "LinkErrorDetail", "type": "string", "required": true, "description": "关联错误详情 注意：此字段可能返回 null，表示取不到有效值。", "example": "CheckError: cluster not found" } ] }, { "name": "Type", "type": "string", "required": false, "description": "类型，取值范围： - TKE - EKS", "example": "TKE" }, { "name": "HostedNamespaces", "type": "array", "required": false, "description": "集群关联的 Namespace 列表", "example": "{\"ns1\",\"ns2\"}", "item_type": "string" } ] }, { "name": "TagList", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "k1" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "v1" }, { "name": "Passthrough", "type": "boolean", "required": false, "description": "是否透传给其他关联产品", "example": "true" } ] } ], "required": [ "DisplayName", "MeshVersion", "Type", "Config" ] }, { "name": "DeleteMesh", "description": "删除网格", "status": "online", "parameters": [ { "name": "MeshId", "type": "string", "required": true, "description": "需要删除的MeshId", "example": "mesh-xxxxxxxx" }, { "name": "NeedDeleteCLS", "type": "boolean", "required": false, "description": "CLS组件是否被删除", "example": "false" }, { "name": "NeedDeleteTMP", "type": "boolean", "required": false, "description": "TMP组件是否被删除", "example": "false" }, { "name": "NeedDeleteAPM", "type": "boolean", "required": false, "description": "APM组件是否被删除", "example": "false" }, { "name": "NeedDeleteGrafana", "type": "boolean", "required": false, "description": "Grafana组件是否被删除", "example": "false" } ], "required": [ "MeshId" ] }, { "name": "DescribeAccessLogConfig", "description": "获取AccessLog配置", "status": "online", "parameters": [ { "name": "MeshId", "type": "string", "required": true, "description": "mesh名字", "example": "mesh-xxxxxxxx" } ], "required": [ "MeshId" ] }, { "name": "DescribeMesh", "description": "查询网格详情", "status": "online", "parameters": [ { "name": "MeshId", "type": "string", "required": true, "description": "需要查询的网格 Id", "example": "mesh-xxxxxxxx" } ], "required": [ "MeshId" ] }, { "name": "DescribeMeshList", "description": "查询网格列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "mesh-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "{\"Mesh1\", \"Mesh2\"}", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "分页限制", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移", "example": "0" } ], "required": [] }, { "name": "LinkClusterList", "description": "关联集群", "status": "online", "parameters": [ { "name": "MeshId", "type": "string", "required": true, "description": "网格Id", "example": "mesh-xxxxxxxxx" }, { "name": "ClusterList", "type": "array", "required": true, "description": "关联集群", "example": "无", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id", "example": "cls-i3wbzkfl" }, { "name": "Region", "type": "string", "required": true, "description": "地域", "example": "ap-shanghai" }, { "name": "Role", "type": "string", "required": true, "description": "集群角色，取值范围： - MASTER：控制面所在的主集群 - REMOTE：主集群管理的远端集群", "example": "REMOTE" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网Id", "example": "subnet-xxxxxxxx" }, { "name": "DisplayName", "type": "string", "required": false, "description": "名称，只读", "example": "cluster-test" }, { "name": "State", "type": "string", "required": false, "description": "状态，只读", "example": "RUNNING" }, { "name": "LinkedTime", "type": "string", "required": false, "description": "关联时间，只读", "example": "2025-01-02T10:51:48.338+08:00" }, { "name": "Config", "type": "object", "required": false, "description": "集群配置", "example": "无", "children": [ { "name": "AutoInjectionNamespaceList", "type": "array", "required": true, "description": "自动注入SideCar的NameSpace", "example": "{\"ns1\",\"ns2\"}", "item_type": "string" }, { "name": "IngressGatewayList", "type": "array", "required": false, "description": "Ingress配置列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "IngressGateway 实例名字", "example": "istio-ingressgateway" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "istio-system" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群 ID", "example": "cls-xxxxxxxx" }, { "name": "Service", "type": "object", "required": true, "description": "Service 配置", "example": "无" }, { "name": "Workload", "type": "object", "required": true, "description": "Workload 配置", "example": "无" }, { "name": "LoadBalancer", "type": "object", "required": false, "description": "负载均衡配置，自动创建 CLB 时返回 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Status", "type": "object", "required": false, "description": "IngressGateway 状态信息，只读", "example": "无" }, { "name": "LoadBalancerId", "type": "string", "required": false, "description": "负载均衡实例ID，使用已有 CLB 时返回", "example": "lb-xxxxxxxx" } ] }, { "name": "EgressGatewayList", "type": "array", "required": false, "description": "Egress配置列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "Egress名称", "example": "istio-egressgateway-xxx" }, { "name": "Namespace", "type": "string", "required": true, "description": "所在的Namespace", "example": "default" }, { "name": "Workload", "type": "object", "required": false, "description": "工作负载配置", "example": "无" }, { "name": "Status", "type": "object", "required": false, "description": "工作负载的状态", "example": "无" } ] }, { "name": "Istiod", "type": "object", "required": false, "description": "Istiod配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Workload", "type": "object", "required": false, "description": "工作负载配置", "example": "无" } ] }, { "name": "DeployConfig", "type": "object", "required": false, "description": "部署配置", "example": "无", "children": [ { "name": "NodeSelectType", "type": "string", "required": false, "description": "部署类型，取值范围： - SPECIFIC：专有模式 - AUTO：普通模式", "example": "AUTO" }, { "name": "Nodes", "type": "array", "required": false, "description": "指定的节点", "example": "{\"10.0.0.2\", \"10,0,0,5\"}", "item_type": "string" } ] }, { "name": "AutoInjectionNamespaceStateList", "type": "array", "required": false, "description": "自动注入命名空间状态列表", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "default" }, { "name": "State", "type": "string", "required": false, "description": "注入状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "INJECT_NEW" } ] } ] }, { "name": "Status", "type": "object", "required": false, "description": "详细状态，只读", "example": "无", "children": [ { "name": "LinkState", "type": "string", "required": true, "description": "关联状态，取值范围： - LINKING: 关联中 - LINKED: 已关联 - UNLINKING: 解关联中 - LINK_FAILED: 关联失败 - UNLINK_FAILED: 解关联失败", "example": "linking" }, { "name": "LinkErrorDetail", "type": "string", "required": true, "description": "关联错误详情 注意：此字段可能返回 null，表示取不到有效值。", "example": "CheckError: cluster not found" } ] }, { "name": "Type", "type": "string", "required": false, "description": "类型，取值范围： - TKE - EKS", "example": "TKE" }, { "name": "HostedNamespaces", "type": "array", "required": false, "description": "集群关联的 Namespace 列表", "example": "{\"ns1\",\"ns2\"}", "item_type": "string" } ] } ], "required": [ "MeshId", "ClusterList" ] }, { "name": "LinkPrometheus", "description": "关联Prometheus", "status": "online", "parameters": [ { "name": "MeshID", "type": "string", "required": true, "description": "网格ID", "example": "mesh-xxxxxxxx" }, { "name": "Prometheus", "type": "object", "required": true, "description": "配置", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "虚拟网络Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网Id", "example": "subnet-xxxxxxxx" }, { "name": "Region", "type": "string", "required": false, "description": "地域", "example": "sh" }, { "name": "InstanceId", "type": "string", "required": false, "description": "关联已存在实例Id，不填则默认创建", "example": "prom-86rajg7s" }, { "name": "CustomProm", "type": "object", "required": false, "description": "第三方 Prometheus 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "Prometheus 访问地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "http://x.x.x.x:909" }, { "name": "AuthType", "type": "string", "required": true, "description": "认证方式 注意：此字段可能返回 null，表示取不到有效值。", "example": "none, basic" }, { "name": "IsPublicAddr", "type": "boolean", "required": false, "description": "是否公网地址，缺省为 false 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "VpcId", "type": "string", "required": false, "description": "虚拟网络id 注意：此字段可能返回 null，表示取不到有效值。", "example": "vpc-xxxxxxxx" }, { "name": "Username", "type": "string", "required": false, "description": "Prometheus 用户名（用于 basic 认证方式） 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "Prometheus 密码（用于 basic 认证方式） 注意：此字段可能返回 null，表示取不到有效值。", "example": "password" } ] } ] } ], "required": [ "MeshID", "Prometheus" ] }, { "name": "ModifyAccessLogConfig", "description": "修改访问日志配置", "status": "online", "parameters": [ { "name": "MeshId", "type": "string", "required": true, "description": "mesh ID", "example": "mesh-xxx" }, { "name": "SelectedRange", "type": "object", "required": false, "description": "选中的范围", "example": "无", "children": [ { "name": "Items", "type": "array", "required": false, "description": "选中的项目详细内容", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "ns" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "cls-test" }, { "name": "ItemName", "type": "string", "required": false, "description": "选中项目名字", "example": "istio-proxy sidecar" }, { "name": "Gateways", "type": "array", "required": false, "description": "ingress gw的名称列表", "example": "[gw-1,gw-2]", "item_type": "string" } ] }, { "name": "All", "type": "boolean", "required": false, "description": "是否全选", "example": "false" } ] }, { "name": "Template", "type": "string", "required": false, "description": "采用的模板，可选值：istio（默认）、trace、custom", "example": "istio" }, { "name": "Enable", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "CLS", "type": "object", "required": false, "description": "腾讯云日志服务相关参数", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否启用", "example": "true" }, { "name": "LogSet", "type": "string", "required": false, "description": "日志集", "example": "mesh-xxx" }, { "name": "Topic", "type": "string", "required": false, "description": "日志主题", "example": "accesslog" }, { "name": "NeedDelete", "type": "boolean", "required": false, "description": "是否删除", "example": "false" }, { "name": "Region", "type": "string", "required": false, "description": "cls 主题创建的地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh" } ] }, { "name": "Encoding", "type": "string", "required": false, "description": "编码格式，可选值：TEXT、JSON", "example": "TEXT" }, { "name": "Format", "type": "string", "required": false, "description": "日志格式", "example": "[%START_TIME%]" }, { "name": "EnableStdout", "type": "boolean", "required": false, "description": "是否启用标准输出", "example": "false" }, { "name": "EnableServer", "type": "boolean", "required": false, "description": "是否启动GRPC第三方服务器", "example": "false" }, { "name": "Address", "type": "string", "required": false, "description": "GRPC第三方服务器地址", "example": "x.x.x.x" } ], "required": [ "MeshId" ] }, { "name": "ModifyMesh", "description": "修改网格", "status": "online", "parameters": [ { "name": "MeshId", "type": "string", "required": true, "description": "需要修改的网格Id", "example": "mesh-xxxxxxxx" }, { "name": "DisplayName", "type": "string", "required": false, "description": "修改的网格名称", "example": "name" }, { "name": "Config", "type": "object", "required": false, "description": "修改的网格配置", "example": "无", "children": [ { "name": "Istio", "type": "object", "required": false, "description": "Istio配置", "example": "无", "children": [ { "name": "OutboundTrafficPolicy", "type": "string", "required": true, "description": "外部流量策略", "example": "ALLOW_ANY" }, { "name": "Tracing", "type": "object", "required": false, "description": "调用链配置（Deprecated，请使用 MeshConfig.Tracing 进行配置）", "example": "无", "children": [ { "name": "Sampling", "type": "float", "required": false, "description": "调用链采样率，百分比", "example": "1.0" }, { "name": "Enable", "type": "boolean", "required": false, "description": "是否启用调用跟踪", "example": "true" }, { "name": "APM", "type": "object", "required": false, "description": "腾讯云 APM 服务相关参数", "example": "无" }, { "name": "Zipkin", "type": "object", "required": false, "description": "启动第三方服务器的地址", "example": "无" } ] }, { "name": "DisablePolicyChecks", "type": "boolean", "required": false, "description": "禁用策略检查功能 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "EnablePilotHTTP", "type": "boolean", "required": false, "description": "支持HTTP1.0协议 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "DisableHTTPRetry", "type": "boolean", "required": false, "description": "禁用HTTP重试策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SmartDNS", "type": "object", "required": false, "description": "SmartDNS策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "IstioMetaDNSCapture", "type": "boolean", "required": false, "description": "开启DNS代理 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "IstioMetaDNSAutoAllocate", "type": "boolean", "required": false, "description": "开启自动地址分配 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] } ] }, { "name": "AccessLog", "type": "object", "required": false, "description": "AccessLog配置", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "Template", "type": "string", "required": false, "description": "采用的模板，可选值：istio（默认）、trace", "example": "istio" }, { "name": "SelectedRange", "type": "object", "required": false, "description": "选中的范围", "example": "无", "children": [ { "name": "Items", "type": "array", "required": false, "description": "选中的项目详细内容", "example": "无", "item_type": "string" }, { "name": "All", "type": "boolean", "required": false, "description": "是否全选", "example": "false" } ] }, { "name": "CLS", "type": "object", "required": false, "description": "腾讯云日志服务相关参数", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否启用", "example": "true" }, { "name": "LogSet", "type": "string", "required": false, "description": "日志集", "example": "mesh-xxx" }, { "name": "Topic", "type": "string", "required": false, "description": "日志主题", "example": "accesslog" }, { "name": "NeedDelete", "type": "boolean", "required": false, "description": "是否删除", "example": "false" }, { "name": "Region", "type": "string", "required": false, "description": "cls 主题创建的地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh" } ] }, { "name": "Encoding", "type": "string", "required": false, "description": "编码格式，可选值：TEXT、JSON", "example": "TEXT" }, { "name": "Format", "type": "string", "required": false, "description": "日志格式", "example": "[%START_TIME%]" }, { "name": "Address", "type": "string", "required": false, "description": "GRPC第三方服务器地址", "example": "172.0.3.6:80" }, { "name": "EnableServer", "type": "boolean", "required": false, "description": "是否启用GRPC第三方服务器", "example": "true" }, { "name": "EnableStdout", "type": "boolean", "required": false, "description": "是否启用标准输出", "example": "true" } ] }, { "name": "Prometheus", "type": "object", "required": false, "description": "Prometheus配置", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "虚拟网络Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网Id", "example": "subnet-xxxxxxxx" }, { "name": "Region", "type": "string", "required": false, "description": "地域", "example": "sh" }, { "name": "InstanceId", "type": "string", "required": false, "description": "关联已存在实例Id，不填则默认创建", "example": "prom-86rajg7s" }, { "name": "CustomProm", "type": "object", "required": false, "description": "第三方 Prometheus 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "Prometheus 访问地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "http://x.x.x.x:909" }, { "name": "AuthType", "type": "string", "required": true, "description": "认证方式 注意：此字段可能返回 null，表示取不到有效值。", "example": "none, basic" }, { "name": "IsPublicAddr", "type": "boolean", "required": false, "description": "是否公网地址，缺省为 false 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "VpcId", "type": "string", "required": false, "description": "虚拟网络id 注意：此字段可能返回 null，表示取不到有效值。", "example": "vpc-xxxxxxxx" }, { "name": "Username", "type": "string", "required": false, "description": "Prometheus 用户名（用于 basic 认证方式） 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "Prometheus 密码（用于 basic 认证方式） 注意：此字段可能返回 null，表示取不到有效值。", "example": "password" } ] } ] }, { "name": "Inject", "type": "object", "required": false, "description": "自动注入配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExcludeIPRanges", "type": "array", "required": false, "description": "不需要进行代理的 ip 地址范围 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"10.0.1.0/24\",\"10.0.2.0/24\"]", "item_type": "string" }, { "name": "HoldApplicationUntilProxyStarts", "type": "boolean", "required": false, "description": "是否等待sidecar启动 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "HoldProxyUntilApplicationEnds", "type": "boolean", "required": false, "description": "是否允许sidecar等待 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "Tracing", "type": "object", "required": false, "description": "调用跟踪配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Sampling", "type": "float", "required": false, "description": "调用链采样率，百分比", "example": "1.0" }, { "name": "Enable", "type": "boolean", "required": false, "description": "是否启用调用跟踪", "example": "true" }, { "name": "APM", "type": "object", "required": false, "description": "腾讯云 APM 服务相关参数", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否启用", "example": "true" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-shanghai" }, { "name": "InstanceId", "type": "string", "required": false, "description": "APM 实例，如果创建时传入的参数为空，则表示自动创建 APM 实例。 注意：此字段可能返回 null，表示取不到有效值。", "example": "apm-LmCpqBQaq" }, { "name": "NeedDelete", "type": "boolean", "required": false, "description": "是否要删除APM实例 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "Zipkin", "type": "object", "required": false, "description": "启动第三方服务器的地址", "example": "无", "children": [ { "name": "Address", "type": "string", "required": true, "description": "Zipkin调用地址", "example": "http://10.0.0.2" } ] } ] }, { "name": "SidecarResources", "type": "object", "required": false, "description": "Sidecar自定义资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Limits", "type": "array", "required": false, "description": "Limits 描述了允许的最大计算资源量。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "资源类型 cpu/memory", "example": "cpu" }, { "name": "Quantity", "type": "string", "required": false, "description": "资源数量", "example": "1" } ] }, { "name": "Requests", "type": "array", "required": false, "description": "Requests 描述所需的最小计算资源量。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "资源类型 cpu/memory", "example": "cpu" }, { "name": "Quantity", "type": "string", "required": false, "description": "资源数量", "example": "1" } ] } ] } ] }, { "name": "ClusterList", "type": "array", "required": false, "description": "修改的集群配置", "example": "无", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id", "example": "cls-i3wbzkfl" }, { "name": "Region", "type": "string", "required": true, "description": "地域", "example": "ap-shanghai" }, { "name": "Role", "type": "string", "required": true, "description": "集群角色，取值范围： - MASTER：控制面所在的主集群 - REMOTE：主集群管理的远端集群", "example": "REMOTE" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网Id", "example": "subnet-xxxxxxxx" }, { "name": "DisplayName", "type": "string", "required": false, "description": "名称，只读", "example": "cluster-test" }, { "name": "State", "type": "string", "required": false, "description": "状态，只读", "example": "RUNNING" }, { "name": "LinkedTime", "type": "string", "required": false, "description": "关联时间，只读", "example": "2025-01-02T10:51:48.338+08:00" }, { "name": "Config", "type": "object", "required": false, "description": "集群配置", "example": "无", "children": [ { "name": "AutoInjectionNamespaceList", "type": "array", "required": true, "description": "自动注入SideCar的NameSpace", "example": "{\"ns1\",\"ns2\"}", "item_type": "string" }, { "name": "IngressGatewayList", "type": "array", "required": false, "description": "Ingress配置列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "IngressGateway 实例名字", "example": "istio-ingressgateway" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "istio-system" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群 ID", "example": "cls-xxxxxxxx" }, { "name": "Service", "type": "object", "required": true, "description": "Service 配置", "example": "无" }, { "name": "Workload", "type": "object", "required": true, "description": "Workload 配置", "example": "无" }, { "name": "LoadBalancer", "type": "object", "required": false, "description": "负载均衡配置，自动创建 CLB 时返回 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Status", "type": "object", "required": false, "description": "IngressGateway 状态信息，只读", "example": "无" }, { "name": "LoadBalancerId", "type": "string", "required": false, "description": "负载均衡实例ID，使用已有 CLB 时返回", "example": "lb-xxxxxxxx" } ] }, { "name": "EgressGatewayList", "type": "array", "required": false, "description": "Egress配置列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "Egress名称", "example": "istio-egressgateway-xxx" }, { "name": "Namespace", "type": "string", "required": true, "description": "所在的Namespace", "example": "default" }, { "name": "Workload", "type": "object", "required": false, "description": "工作负载配置", "example": "无" }, { "name": "Status", "type": "object", "required": false, "description": "工作负载的状态", "example": "无" } ] }, { "name": "Istiod", "type": "object", "required": false, "description": "Istiod配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Workload", "type": "object", "required": false, "description": "工作负载配置", "example": "无" } ] }, { "name": "DeployConfig", "type": "object", "required": false, "description": "部署配置", "example": "无", "children": [ { "name": "NodeSelectType", "type": "string", "required": false, "description": "部署类型，取值范围： - SPECIFIC：专有模式 - AUTO：普通模式", "example": "AUTO" }, { "name": "Nodes", "type": "array", "required": false, "description": "指定的节点", "example": "{\"10.0.0.2\", \"10,0,0,5\"}", "item_type": "string" } ] }, { "name": "AutoInjectionNamespaceStateList", "type": "array", "required": false, "description": "自动注入命名空间状态列表", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "default" }, { "name": "State", "type": "string", "required": false, "description": "注入状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "INJECT_NEW" } ] } ] }, { "name": "Status", "type": "object", "required": false, "description": "详细状态，只读", "example": "无", "children": [ { "name": "LinkState", "type": "string", "required": true, "description": "关联状态，取值范围： - LINKING: 关联中 - LINKED: 已关联 - UNLINKING: 解关联中 - LINK_FAILED: 关联失败 - UNLINK_FAILED: 解关联失败", "example": "linking" }, { "name": "LinkErrorDetail", "type": "string", "required": true, "description": "关联错误详情 注意：此字段可能返回 null，表示取不到有效值。", "example": "CheckError: cluster not found" } ] }, { "name": "Type", "type": "string", "required": false, "description": "类型，取值范围： - TKE - EKS", "example": "TKE" }, { "name": "HostedNamespaces", "type": "array", "required": false, "description": "集群关联的 Namespace 列表", "example": "{\"ns1\",\"ns2\"}", "item_type": "string" } ] } ], "required": [ "MeshId" ] }, { "name": "ModifyTracingConfig", "description": "修改 Tracing 配置", "status": "online", "parameters": [ { "name": "MeshId", "type": "string", "required": true, "description": "mesh名字", "example": "mesh-xxx" }, { "name": "Enable", "type": "boolean", "required": false, "description": "是否启用调用跟踪", "example": "true" }, { "name": "APM", "type": "object", "required": false, "description": "腾讯云 APM 服务相关参数", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否启用", "example": "true" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-shanghai" }, { "name": "InstanceId", "type": "string", "required": false, "description": "APM 实例，如果创建时传入的参数为空，则表示自动创建 APM 实例。 注意：此字段可能返回 null，表示取不到有效值。", "example": "apm-LmCpqBQaq" }, { "name": "NeedDelete", "type": "boolean", "required": false, "description": "是否要删除APM实例 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "Sampling", "type": "float", "required": false, "description": "调用跟踪采样值", "example": "1.0" }, { "name": "Zipkin", "type": "object", "required": false, "description": "调用追踪Zipkin相关配置", "example": "xxx", "children": [ { "name": "Address", "type": "string", "required": true, "description": "Zipkin调用地址", "example": "http://10.0.0.2" } ] } ], "required": [ "MeshId" ] }, { "name": "UnlinkCluster", "description": "解关联集群", "status": "online", "parameters": [ { "name": "MeshId", "type": "string", "required": true, "description": "网格Id", "example": "mesh-xxxxxxxx" }, { "name": "ClusterId", "type": "string", "required": false, "description": "取消关联的集群Id", "example": "cls-xxxxxxxx" } ], "required": [ "MeshId" ] }, { "name": "UnlinkPrometheus", "description": "解除关联Prometheus", "status": "online", "parameters": [ { "name": "MeshID", "type": "string", "required": true, "description": "网格ID", "example": "mesh-xxxxxxxx" } ], "required": [ "MeshID" ] } ] }