{ "name": "tse", "display_name": "TSF-Polaris\u0026ZK\u0026网关", "description": "介绍如何使用 API 对腾讯云微服务平台进行操作，包括创建托管服务集群、查询集群信息等。", "domain": "other", "api_version": "2020-12-07", "endpoint": "tse.tencentcloudapi.com", "actions": [ { "name": "BindAutoScalerResourceStrategyToGroups", "description": "弹性伸缩策略批量绑定网关分组", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-4a34cf5f" }, { "name": "StrategyId", "type": "string", "required": true, "description": "策略ID", "example": "strategy-7bb4fcb0" }, { "name": "GroupIds", "type": "array", "required": true, "description": "网关分组ID列表", "example": "group-4se0czf7", "item_type": "string" } ], "required": [ "GatewayId", "StrategyId", "GroupIds" ] }, { "name": "CloseWafProtection", "description": "关闭 WAF 防护", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Type", "type": "string", "required": true, "description": "防护资源的类型。 - Global 实例 - Service 服务 - Route 路由 - Object 对象", "example": "Global" }, { "name": "List", "type": "array", "required": false, "description": "当资源类型 Type 是 Service 或 Route 的时候，传入的服务或路由的列表", "example": "2a212560-220a-46f6-b139-3238eb8ea041", "item_type": "string" } ], "required": [ "GatewayId", "Type" ] }, { "name": "CreateAutoScalerResourceStrategy", "description": "创建弹性伸缩策略", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-4a34cf5f" }, { "name": "StrategyName", "type": "string", "required": true, "description": "策略名称", "example": "strategy-test" }, { "name": "Description", "type": "string", "required": false, "description": "策略描述", "example": "desc" }, { "name": "Config", "type": "object", "required": false, "description": "指标伸缩配置", "example": "无", "children": [ { "name": "MaxReplicas", "type": "integer", "required": false, "description": "最大副本数", "example": "5" }, { "name": "Metrics", "type": "array", "required": false, "description": "指标列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "指标类型 - Resource", "example": "Resource" }, { "name": "ResourceName", "type": "string", "required": false, "description": "指标资源名称 - cpu - memory", "example": "cpu" }, { "name": "TargetType", "type": "string", "required": false, "description": "指标目标类型，目前只支持百分比Utilization", "example": "Utilization" }, { "name": "TargetValue", "type": "integer", "required": false, "description": "指标目标值", "example": "80" } ] }, { "name": "Behavior", "type": "object", "required": false, "description": "指标伸缩行为配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ScaleUp", "type": "object", "required": false, "description": "扩容行为配置", "example": "无", "children": [ { "name": "StabilizationWindowSeconds", "type": "integer", "required": false, "description": "稳定窗口时间，扩容时默认0，缩容时默认300", "example": "300" }, { "name": "SelectPolicy", "type": "string", "required": false, "description": "选择策略依据", "example": "Max" }, { "name": "Policies", "type": "array", "required": false, "description": "扩缩容策略", "example": "无", "item_type": "string" } ] }, { "name": "ScaleDown", "type": "object", "required": false, "description": "缩容行为配置", "example": "无", "children": [ { "name": "StabilizationWindowSeconds", "type": "integer", "required": false, "description": "稳定窗口时间，扩容时默认0，缩容时默认300", "example": "300" }, { "name": "SelectPolicy", "type": "string", "required": false, "description": "选择策略依据", "example": "Max" }, { "name": "Policies", "type": "array", "required": false, "description": "扩缩容策略", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "CronConfig", "type": "object", "required": false, "description": "定时伸缩配置", "example": "无", "children": [ { "name": "Params", "type": "array", "required": false, "description": "定时伸缩配置参数列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Period", "type": "string", "required": false, "description": "定时伸缩周期", "example": "1 * *" }, { "name": "StartAt", "type": "string", "required": false, "description": "定时伸缩开始时间", "example": "17:00" }, { "name": "TargetReplicas", "type": "integer", "required": false, "description": "定时伸缩目标节点数，不超过指标伸缩中定义的最大节点数", "example": "50" }, { "name": "Crontab", "type": "string", "required": false, "description": "定时伸缩cron表达式，无需输入", "example": "0 00 00 * * *" } ] } ] } ], "required": [ "GatewayId", "StrategyName" ] }, { "name": "CreateCloudNativeAPIGateway", "description": "创建云原生API网关实例", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "云原生API网关名字, 最多支持60个字符。", "example": "kong-test" }, { "name": "Type", "type": "string", "required": true, "description": "云原生API网关类型, 目前只支持kong。", "example": "kong" }, { "name": "GatewayVersion", "type": "string", "required": true, "description": "云原生API网关版本。参考值： - 2.4.1 - 2.5.1", "example": "2.4.1" }, { "name": "NodeConfig", "type": "object", "required": true, "description": "云原生API网关节点配置。", "example": "无", "children": [ { "name": "Specification", "type": "string", "required": true, "description": "节点配置, 1c2g|2c4g|4c8g|8c16g。", "example": "1c2g" }, { "name": "Number", "type": "integer", "required": true, "description": "节点数量，2-9。", "example": "2" } ] }, { "name": "VpcConfig", "type": "object", "required": true, "description": "云原生API网关vpc配置。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID。", "example": "vpc-xxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID。", "example": "subnet-xxxxxx" } ] }, { "name": "Description", "type": "string", "required": false, "description": "云原生API网关描述信息, 最多支持120个字符。", "example": "kong test" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "value" } ] }, { "name": "EnableCls", "type": "boolean", "required": false, "description": "是否开启 CLS 日志。默认值：fasle", "example": "false" }, { "name": "FeatureVersion", "type": "string", "required": false, "description": "产品版本。参考值： - TRIAL：开发版 - STANDARD：标准版 （默认值） - PROFESSIONAL：专业版", "example": "STANDARD" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出流量带宽，[1,2048]Mbps", "example": "10" }, { "name": "EngineRegion", "type": "string", "required": false, "description": "实例实际的地域信息，默认值：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "IngressClassName", "type": "string", "required": false, "description": "ingress Class名称", "example": "nginx" }, { "name": "TradeType", "type": "integer", "required": false, "description": "付费类型。参考值： 0：后付费（默认值） 1：预付费（接口暂不支持创建预付费实例）", "example": "0" }, { "name": "InternetConfig", "type": "object", "required": false, "description": "公网相关配置", "example": "无", "children": [ { "name": "InternetAddressVersion", "type": "string", "required": false, "description": "公网地址版本，可选：\"IPV4\" | \"IPV6\" 。不填默认 IPV4 。", "example": "IPV6" }, { "name": "InternetPayMode", "type": "string", "required": false, "description": "公网付费类型，当前仅可选：\"BANDWIDTH\"。不填默认为 \"BANDWIDTH\"", "example": "BANDWIDTH" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网带宽。", "example": "5" }, { "name": "Description", "type": "string", "required": false, "description": "负载均衡描述", "example": "公网入口" }, { "name": "SlaType", "type": "string", "required": false, "description": "负载均衡的规格类型，支持clb.c2.medium、clb.c3.small、clb.c3.medium、clb.c4.small、clb.c4.medium、clb.c4.large、clb.c4.xlarge，不传为共享型。", "example": "clb.c4.small" }, { "name": "MultiZoneFlag", "type": "boolean", "required": false, "description": "负载均衡是否多可用区", "example": "false" }, { "name": "MasterZoneId", "type": "string", "required": false, "description": "主可用区", "example": "ap-guangzhou-1" }, { "name": "SlaveZoneId", "type": "string", "required": false, "description": "备可用区", "example": "ap-guangzhou-3" } ] }, { "name": "PromId", "type": "string", "required": false, "description": "关联的prometheus ID", "example": "prom-788xxxxxx" } ], "required": [ "Name", "Type", "GatewayVersion", "NodeConfig", "VpcConfig" ] }, { "name": "CreateCloudNativeAPIGatewayCanaryRule", "description": "创建云原生网关的灰度规则", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID", "example": "gateway-962b7d7c" }, { "name": "ServiceId", "type": "string", "required": true, "description": "服务 ID", "example": "service-xx" }, { "name": "CanaryRule", "type": "object", "required": false, "description": "灰度规则配置", "example": "无", "children": [ { "name": "Priority", "type": "integer", "required": true, "description": "优先级，值范围为 0 到 100；值越大，优先级越高；不同规则间优先级不可重复", "example": "100" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "是否启用规则", "example": "true" }, { "name": "ConditionList", "type": "array", "required": false, "description": "参数匹配条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "条件类型，支持 path, method, query, header, cookie, body 和 system。", "example": "header" }, { "name": "Key", "type": "string", "required": false, "description": "参数名", "example": "x-user-id" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符，支持 \"le\", \"eq\", \"lt\", \"ne\", \"ge\", \"gt\", \"regex\", \"exists\", \"in\", \"not in\", \"prefix\" ,\"exact\", \"regex\" 等", "example": "==" }, { "name": "Value", "type": "string", "required": false, "description": "目标参数值", "example": "user-stu" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符，当 Operator 为 in 或者 not in 时生效。支持值为英文逗号，英文分号，空格，换行符。", "example": "," }, { "name": "GlobalConfigId", "type": "string", "required": false, "description": "全局配置 Id", "example": "4fe634e9-ea28-4f1e-8461-da89f3b84d28" }, { "name": "GlobalConfigName", "type": "string", "required": false, "description": "全局配置名称", "example": "global-conf-stu" } ] }, { "name": "BalancedServiceList", "type": "array", "required": false, "description": "服务的流量百分比配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ServiceID", "type": "string", "required": false, "description": "服务 ID，作为入参时，必填", "example": "2a212560-220a-46f6-b139-3238eb8ea041" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称，作为入参时，无意义", "example": "learn" }, { "name": "UpstreamName", "type": "string", "required": false, "description": "Upstream 名称，作为入参时，无意义", "example": "learn" }, { "name": "Percent", "type": "float", "required": false, "description": "百分比，10 即 10%，范围0-100", "example": "10" } ] }, { "name": "ServiceId", "type": "string", "required": false, "description": "归属服务 ID", "example": "2a212560-220a-46f6-b139-3238eb8ea041" }, { "name": "ServiceName", "type": "string", "required": false, "description": "归属服务名称", "example": "learn-svc" }, { "name": "RuleType", "type": "string", "required": false, "description": "灰度规则类别 Standard｜Lane", "example": "Standard" }, { "name": "MatchType", "type": "string", "required": false, "description": "全链路灰度策略多个条件之间的匹配方式，与AND，或OR", "example": "AND" }, { "name": "GroupId", "type": "string", "required": false, "description": "泳道组ID", "example": "group-4se0czf7" }, { "name": "GroupName", "type": "string", "required": false, "description": "泳道组名称", "example": "公网入口分组" }, { "name": "LaneId", "type": "string", "required": false, "description": "泳道ID", "example": "4e00e834cc984314a9a33fa4bb08bc5a" }, { "name": "LaneName", "type": "string", "required": false, "description": "泳道名称", "example": "在线学习服务泳道" }, { "name": "MatchMode", "type": "string", "required": false, "description": "泳道匹配规则：严格STRICT｜宽松PERMISSIVE", "example": "STRICT" }, { "name": "LaneTag", "type": "string", "required": false, "description": "泳道标签", "example": "lane:v1" } ] }, { "name": "CanaryRuleList", "type": "array", "required": false, "description": "灰度规则配置列表，如果配置了此参数，将以此参数为准，忽略CanaryRule参数", "example": "无", "item_type": "object", "children": [ { "name": "Priority", "type": "integer", "required": true, "description": "优先级，值范围为 0 到 100；值越大，优先级越高；不同规则间优先级不可重复", "example": "100" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "是否启用规则", "example": "true" }, { "name": "ConditionList", "type": "array", "required": false, "description": "参数匹配条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "条件类型，支持 path, method, query, header, cookie, body 和 system。", "example": "header" }, { "name": "Key", "type": "string", "required": false, "description": "参数名", "example": "x-user-id" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符，支持 \"le\", \"eq\", \"lt\", \"ne\", \"ge\", \"gt\", \"regex\", \"exists\", \"in\", \"not in\", \"prefix\" ,\"exact\", \"regex\" 等", "example": "==" }, { "name": "Value", "type": "string", "required": false, "description": "目标参数值", "example": "user-stu" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符，当 Operator 为 in 或者 not in 时生效。支持值为英文逗号，英文分号，空格，换行符。", "example": "," }, { "name": "GlobalConfigId", "type": "string", "required": false, "description": "全局配置 Id", "example": "4fe634e9-ea28-4f1e-8461-da89f3b84d28" }, { "name": "GlobalConfigName", "type": "string", "required": false, "description": "全局配置名称", "example": "global-conf-stu" } ] }, { "name": "BalancedServiceList", "type": "array", "required": false, "description": "服务的流量百分比配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ServiceID", "type": "string", "required": false, "description": "服务 ID，作为入参时，必填", "example": "2a212560-220a-46f6-b139-3238eb8ea041" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称，作为入参时，无意义", "example": "learn" }, { "name": "UpstreamName", "type": "string", "required": false, "description": "Upstream 名称，作为入参时，无意义", "example": "learn" }, { "name": "Percent", "type": "float", "required": false, "description": "百分比，10 即 10%，范围0-100", "example": "10" } ] }, { "name": "ServiceId", "type": "string", "required": false, "description": "归属服务 ID", "example": "2a212560-220a-46f6-b139-3238eb8ea041" }, { "name": "ServiceName", "type": "string", "required": false, "description": "归属服务名称", "example": "learn-svc" }, { "name": "RuleType", "type": "string", "required": false, "description": "灰度规则类别 Standard｜Lane", "example": "Standard" }, { "name": "MatchType", "type": "string", "required": false, "description": "全链路灰度策略多个条件之间的匹配方式，与AND，或OR", "example": "AND" }, { "name": "GroupId", "type": "string", "required": false, "description": "泳道组ID", "example": "group-4se0czf7" }, { "name": "GroupName", "type": "string", "required": false, "description": "泳道组名称", "example": "公网入口分组" }, { "name": "LaneId", "type": "string", "required": false, "description": "泳道ID", "example": "4e00e834cc984314a9a33fa4bb08bc5a" }, { "name": "LaneName", "type": "string", "required": false, "description": "泳道名称", "example": "在线学习服务泳道" }, { "name": "MatchMode", "type": "string", "required": false, "description": "泳道匹配规则：严格STRICT｜宽松PERMISSIVE", "example": "STRICT" }, { "name": "LaneTag", "type": "string", "required": false, "description": "泳道标签", "example": "lane:v1" } ] } ], "required": [ "GatewayId", "ServiceId" ] }, { "name": "CreateCloudNativeAPIGatewayCertificate", "description": "创建云原生网关证书", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "BindDomains", "type": "array", "required": true, "description": "绑定的域名", "example": "[\"tencent.com\"]", "item_type": "string" }, { "name": "CertId", "type": "string", "required": true, "description": "ssl平台证书 Id", "example": "12412rew43-5fdsf35" }, { "name": "Name", "type": "string", "required": false, "description": "证书名称", "example": "tencent.com" } ], "required": [ "GatewayId", "BindDomains", "CertId" ] }, { "name": "CreateCloudNativeAPIGatewayPublicNetwork", "description": "创建公网网络配置", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxx1234" }, { "name": "GroupId", "type": "string", "required": false, "description": "分组id。", "example": "group-xxxx1234" }, { "name": "InternetConfig", "type": "object", "required": false, "description": "公网负载均衡配置。", "example": "无", "children": [ { "name": "InternetAddressVersion", "type": "string", "required": false, "description": "公网地址版本，可选：\"IPV4\" | \"IPV6\" 。不填默认 IPV4 。", "example": "IPV6" }, { "name": "InternetPayMode", "type": "string", "required": false, "description": "公网付费类型，当前仅可选：\"BANDWIDTH\"。不填默认为 \"BANDWIDTH\"", "example": "BANDWIDTH" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网带宽。", "example": "5" }, { "name": "Description", "type": "string", "required": false, "description": "负载均衡描述", "example": "公网入口" }, { "name": "SlaType", "type": "string", "required": false, "description": "负载均衡的规格类型，支持clb.c2.medium、clb.c3.small、clb.c3.medium、clb.c4.small、clb.c4.medium、clb.c4.large、clb.c4.xlarge，不传为共享型。", "example": "clb.c4.small" }, { "name": "MultiZoneFlag", "type": "boolean", "required": false, "description": "负载均衡是否多可用区", "example": "false" }, { "name": "MasterZoneId", "type": "string", "required": false, "description": "主可用区", "example": "ap-guangzhou-1" }, { "name": "SlaveZoneId", "type": "string", "required": false, "description": "备可用区", "example": "ap-guangzhou-3" } ] } ], "required": [ "GatewayId" ] }, { "name": "CreateCloudNativeAPIGatewayRoute", "description": "创建云原生网关路由", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "ServiceID", "type": "string", "required": true, "description": "所属服务的ID", "example": "104dd157-5008-4d3c-9feb-4767667863ff" }, { "name": "RouteName", "type": "string", "required": false, "description": "路由的名字，实例级别唯一，可以不提供", "example": "route-demo" }, { "name": "Methods", "type": "array", "required": false, "description": "路由的方法，其中方法可选值： - GET - POST - DELETE - PUT - OPTIONS - PATCH - HEAD - ANY - TRACE - COPY - MOVE - PROPFIND - PROPPATCH - MKCOL - LOCK - UNLOCK", "example": "[\"GET\"]", "item_type": "string" }, { "name": "Hosts", "type": "array", "required": false, "description": "路由的域名", "example": "[\"www.demo.com\"]", "item_type": "string" }, { "name": "Paths", "type": "array", "required": false, "description": "路由的路径", "example": "[\"/\"]", "item_type": "string" }, { "name": "Protocols", "type": "array", "required": false, "description": "路由的协议，可选 - https - http", "example": "[\"https\"]", "item_type": "string" }, { "name": "PreserveHost", "type": "boolean", "required": false, "description": "转发到后端时是否保留Host", "example": "true" }, { "name": "HttpsRedirectStatusCode", "type": "integer", "required": false, "description": "https重定向状态码", "example": "308" }, { "name": "StripPath", "type": "boolean", "required": false, "description": "转发到后端时是否StripPath", "example": "true" }, { "name": "DestinationPorts", "type": "array", "required": false, "description": "四层匹配的目的端口", "example": "7501", "item_type": "integer" }, { "name": "Headers", "type": "array", "required": false, "description": "路由的Headers", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key", "example": "key" }, { "name": "Value", "type": "string", "required": false, "description": "value", "example": "value" } ] }, { "name": "RequestBuffering", "type": "boolean", "required": false, "description": "是否缓存请求body，默认true", "example": "true" }, { "name": "ResponseBuffering", "type": "boolean", "required": false, "description": "是否缓存响应body，默认true", "example": "true" }, { "name": "RegexPriority", "type": "integer", "required": false, "description": "正则优先级", "example": "0" } ], "required": [ "GatewayId", "ServiceID" ] }, { "name": "CreateCloudNativeAPIGatewayRouteRateLimit", "description": "创建云原生网关限流插件(路由)", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Id", "type": "string", "required": true, "description": "路由id，或路由名称。 不支持“未命名”", "example": "5836e46f-1653-4183-a76e-c361540d0831" }, { "name": "LimitDetail", "type": "object", "required": true, "description": "限流配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "插件启用状态", "example": "true" }, { "name": "QpsThresholds", "type": "array", "required": false, "description": "qps阈值", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "Path", "type": "string", "required": false, "description": "需要进行流量控制的请求路径", "example": "/demo" }, { "name": "Header", "type": "string", "required": false, "description": "需要进行流量控制的请求头Key", "example": "Host" }, { "name": "LimitBy", "type": "string", "required": false, "description": "限流依据 ip service consumer credential path header", "example": "ip" }, { "name": "ExternalRedis", "type": "object", "required": false, "description": "外部redis配置", "example": "无", "children": [ { "name": "RedisHost", "type": "string", "required": true, "description": "redis ip", "example": "127.0.0.1" }, { "name": "RedisPassword", "type": "string", "required": true, "description": "redis密码", "example": "password" }, { "name": "RedisPort", "type": "integer", "required": true, "description": "redis端口", "example": "80" }, { "name": "RedisTimeout", "type": "integer", "required": true, "description": "超时时间 ms", "example": "10" } ] }, { "name": "GlobalConfigId", "type": "string", "required": false, "description": "全局配置中的redis配置", "example": "9a4e0f39-fa6a-44d8-8e3e-10f016ad78de" }, { "name": "Policy", "type": "string", "required": false, "description": "计数器策略 local 单机 redis 默认redis external_redis 外部redis", "example": "local" }, { "name": "RateLimitResponse", "type": "object", "required": false, "description": "响应配置，响应策略为text", "example": "无", "children": [ { "name": "Body", "type": "string", "required": false, "description": "自定义响应体", "example": "hello" }, { "name": "Headers", "type": "array", "required": false, "description": "Headers", "example": "[{key:\"\",value:\"\"},]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key", "example": "key" }, { "name": "Value", "type": "string", "required": false, "description": "value", "example": "value" } ] }, { "name": "HttpStatus", "type": "integer", "required": false, "description": "http状态码", "example": "200" } ] }, { "name": "RateLimitResponseUrl", "type": "string", "required": false, "description": "请求转发地址", "example": "http://127.0.0.1/downgrade" }, { "name": "ResponseType", "type": "string", "required": false, "description": "响应策略 url请求转发 text 响应配置 default 直接返回", "example": "url" }, { "name": "HideClientHeaders", "type": "boolean", "required": false, "description": "是否隐藏限流客户端响应头", "example": "true" }, { "name": "LineUpTime", "type": "integer", "required": false, "description": "排队时间", "example": "0" }, { "name": "IsDelay", "type": "boolean", "required": false, "description": "是否开启请求排队", "example": "true" }, { "name": "BasicLimitQpsThresholds", "type": "array", "required": false, "description": "基础限流 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "LimitRules", "type": "array", "required": false, "description": "参数限流的规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "请求匹配条件", "example": "{\"Key\":\"ip\",\"Values\":[\"8.8.8.8/24\"]}", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "限流条件的Key", "example": "ip" }, { "name": "Values", "type": "array", "required": false, "description": "限流条件的Values", "example": "8.8.8.8/24", "item_type": "string" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符", "example": "eq" }, { "name": "Name", "type": "string", "required": false, "description": "header或query对应的name", "example": "Auth" } ] }, { "name": "LimitBy", "type": "array", "required": false, "description": "参数限流依据组合", "example": "[{\"Key\":\"ip\",\"Value\":\"\"},{\"Key\":\"header\",\"Value\":\"host\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "条件的Key", "example": "header" }, { "name": "Value", "type": "string", "required": false, "description": "条件的Value", "example": "host" } ] }, { "name": "QpsThresholds", "type": "array", "required": false, "description": "限流阈值", "example": "[{\"Unit\":\"second\",\"Max\":10000}]", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "AccurateQpsThresholds", "type": "array", "required": false, "description": "精确限流阈值", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "GlobalConfigId", "type": "string", "required": true, "description": "全局配置ID", "example": "aa2090e1-0117-404f-b73f-69b662b6834f" } ] } ] } ] } ], "required": [ "GatewayId", "Id", "LimitDetail" ] }, { "name": "CreateCloudNativeAPIGatewayService", "description": "创建云原生网关服务", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "服务名称", "example": "service-demo" }, { "name": "Protocol", "type": "string", "required": true, "description": "请求协议： - https - http - tcp - udp", "example": "http" }, { "name": "Timeout", "type": "integer", "required": true, "description": "超时时间，单位ms", "example": "5000" }, { "name": "Retries", "type": "integer", "required": true, "description": "重试次数", "example": "0" }, { "name": "UpstreamType", "type": "string", "required": true, "description": "服务类型: - Kubernetes - Registry - IPList - HostIP - Scf", "example": "HostIP" }, { "name": "UpstreamInfo", "type": "object", "required": true, "description": "服务配置信息", "example": "无", "children": [ { "name": "Host", "type": "string", "required": false, "description": "IP或域名", "example": "www.test.com" }, { "name": "Port", "type": "integer", "required": false, "description": "端口", "example": "80" }, { "name": "SourceID", "type": "string", "required": false, "description": "服务来源ID", "example": "ins-102555d0" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "Default" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务（注册中心或Kubernetes中的服务）名字", "example": "demo-service" }, { "name": "Targets", "type": "array", "required": false, "description": "服务后端类型是IPList时提供 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Host", "type": "string", "required": true, "description": "Host", "example": "8.8.8.8" }, { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "100" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重", "example": "10" }, { "name": "Health", "type": "string", "required": false, "description": "健康状态", "example": "HEALTHY" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间", "example": "2024-11-25 10:49:23" }, { "name": "Source", "type": "string", "required": false, "description": "Target的来源", "example": "AutoScaling" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例ID", "example": "ins-ze3124da" }, { "name": "CvmInstanceName", "type": "string", "required": false, "description": "CVM实例名称", "example": "在线学习服务" }, { "name": "Tags", "type": "array", "required": false, "description": "target标签", "example": "learn", "item_type": "string" } ] }, { "name": "SourceType", "type": "string", "required": false, "description": "服务来源类型", "example": "TKE" }, { "name": "ScfType", "type": "string", "required": false, "description": "SCF函数类型", "example": "event" }, { "name": "ScfNamespace", "type": "string", "required": false, "description": "SCF函数命名空间", "example": "Default" }, { "name": "ScfLambdaName", "type": "string", "required": false, "description": "SCF函数名", "example": "helloworld" }, { "name": "ScfLambdaQualifier", "type": "string", "required": false, "description": "SCF函数版本", "example": "$LATEST" }, { "name": "SlowStart", "type": "integer", "required": false, "description": "冷启动时间，单位秒", "example": "60" }, { "name": "Algorithm", "type": "string", "required": false, "description": "负载均衡算法，默认为 round-robin，还支持 least-connections，consisten_hashing", "example": "round-robin" }, { "name": "AutoScalingGroupID", "type": "string", "required": false, "description": "CVM弹性伸缩组ID", "example": "as-4se0czf7" }, { "name": "AutoScalingCvmPort", "type": "integer", "required": false, "description": "CVM弹性伸缩组端口", "example": "80" }, { "name": "AutoScalingTatCmdStatus", "type": "string", "required": false, "description": "CVM弹性伸缩组使用的CVM TAT命令状态", "example": "Normal" }, { "name": "AutoScalingHookStatus", "type": "string", "required": false, "description": "CVM弹性伸缩组生命周期挂钩状态", "example": "Normal" }, { "name": "SourceName", "type": "string", "required": false, "description": "服务来源的名字", "example": "tse-polaris" }, { "name": "RealSourceType", "type": "string", "required": false, "description": "精确的服务来源类型，新建服务来源时候传入的类型", "example": "TKE" }, { "name": "HealthStatus", "type": "string", "required": false, "description": "upstream健康状态HEALTHY（健康）, UNHEALTHY（异常）, HEALTHCHECKS_OFF（未开启）和NONE（不支持健康检查）", "example": "HEALTHY" }, { "name": "ScfCamAuthEnable", "type": "boolean", "required": false, "description": "云函数是否开启CAM鉴权，不填时默认为开启(true)", "example": "true" }, { "name": "ScfIsBase64Encoded", "type": "boolean", "required": false, "description": "云函数是否开启Base64编码，默认为false", "example": "false" }, { "name": "ScfIsIntegratedResponse", "type": "boolean", "required": false, "description": "云函数是否开启响应集成，默认为false", "example": "false" } ] }, { "name": "Path", "type": "string", "required": false, "description": "请求路径", "example": "/v1/users" } ], "required": [ "GatewayId", "Name", "Protocol", "Timeout", "Retries", "UpstreamType", "UpstreamInfo" ] }, { "name": "CreateCloudNativeAPIGatewayServiceRateLimit", "description": "创建云原生网关限流插件(服务)", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "服务名称，或服务ID", "example": "service-demo" }, { "name": "LimitDetail", "type": "object", "required": true, "description": "限流配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "插件启用状态", "example": "true" }, { "name": "QpsThresholds", "type": "array", "required": false, "description": "qps阈值", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "Path", "type": "string", "required": false, "description": "需要进行流量控制的请求路径", "example": "/demo" }, { "name": "Header", "type": "string", "required": false, "description": "需要进行流量控制的请求头Key", "example": "Host" }, { "name": "LimitBy", "type": "string", "required": false, "description": "限流依据 ip service consumer credential path header", "example": "ip" }, { "name": "ExternalRedis", "type": "object", "required": false, "description": "外部redis配置", "example": "无", "children": [ { "name": "RedisHost", "type": "string", "required": true, "description": "redis ip", "example": "127.0.0.1" }, { "name": "RedisPassword", "type": "string", "required": true, "description": "redis密码", "example": "password" }, { "name": "RedisPort", "type": "integer", "required": true, "description": "redis端口", "example": "80" }, { "name": "RedisTimeout", "type": "integer", "required": true, "description": "超时时间 ms", "example": "10" } ] }, { "name": "GlobalConfigId", "type": "string", "required": false, "description": "全局配置中的redis配置", "example": "9a4e0f39-fa6a-44d8-8e3e-10f016ad78de" }, { "name": "Policy", "type": "string", "required": false, "description": "计数器策略 local 单机 redis 默认redis external_redis 外部redis", "example": "local" }, { "name": "RateLimitResponse", "type": "object", "required": false, "description": "响应配置，响应策略为text", "example": "无", "children": [ { "name": "Body", "type": "string", "required": false, "description": "自定义响应体", "example": "hello" }, { "name": "Headers", "type": "array", "required": false, "description": "Headers", "example": "[{key:\"\",value:\"\"},]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key", "example": "key" }, { "name": "Value", "type": "string", "required": false, "description": "value", "example": "value" } ] }, { "name": "HttpStatus", "type": "integer", "required": false, "description": "http状态码", "example": "200" } ] }, { "name": "RateLimitResponseUrl", "type": "string", "required": false, "description": "请求转发地址", "example": "http://127.0.0.1/downgrade" }, { "name": "ResponseType", "type": "string", "required": false, "description": "响应策略 url请求转发 text 响应配置 default 直接返回", "example": "url" }, { "name": "HideClientHeaders", "type": "boolean", "required": false, "description": "是否隐藏限流客户端响应头", "example": "true" }, { "name": "LineUpTime", "type": "integer", "required": false, "description": "排队时间", "example": "0" }, { "name": "IsDelay", "type": "boolean", "required": false, "description": "是否开启请求排队", "example": "true" }, { "name": "BasicLimitQpsThresholds", "type": "array", "required": false, "description": "基础限流 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "LimitRules", "type": "array", "required": false, "description": "参数限流的规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "请求匹配条件", "example": "{\"Key\":\"ip\",\"Values\":[\"8.8.8.8/24\"]}", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "限流条件的Key", "example": "ip" }, { "name": "Values", "type": "array", "required": false, "description": "限流条件的Values", "example": "8.8.8.8/24", "item_type": "string" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符", "example": "eq" }, { "name": "Name", "type": "string", "required": false, "description": "header或query对应的name", "example": "Auth" } ] }, { "name": "LimitBy", "type": "array", "required": false, "description": "参数限流依据组合", "example": "[{\"Key\":\"ip\",\"Value\":\"\"},{\"Key\":\"header\",\"Value\":\"host\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "条件的Key", "example": "header" }, { "name": "Value", "type": "string", "required": false, "description": "条件的Value", "example": "host" } ] }, { "name": "QpsThresholds", "type": "array", "required": false, "description": "限流阈值", "example": "[{\"Unit\":\"second\",\"Max\":10000}]", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "AccurateQpsThresholds", "type": "array", "required": false, "description": "精确限流阈值", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "GlobalConfigId", "type": "string", "required": true, "description": "全局配置ID", "example": "aa2090e1-0117-404f-b73f-69b662b6834f" } ] } ] } ] } ], "required": [ "GatewayId", "Name", "LimitDetail" ] }, { "name": "CreateConfigFile", "description": "创建配置文件", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE 实例id", "example": "janice-test" }, { "name": "ConfigFile", "type": "object", "required": true, "description": "配置文件列表详情", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "配置文件id", "example": "configId" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件名称", "example": "application" }, { "name": "Namespace", "type": "string", "required": false, "description": "配置文件命名空间", "example": "namespaceName" }, { "name": "Group", "type": "string", "required": false, "description": "配置文件组", "example": "groupName" }, { "name": "Content", "type": "string", "required": false, "description": "配置文件内容", "example": "configContent" }, { "name": "Format", "type": "string", "required": false, "description": "配置文件格式", "example": "text" }, { "name": "Comment", "type": "string", "required": false, "description": "配置文件注释", "example": "Comment" }, { "name": "Status", "type": "string", "required": false, "description": "配置文件状态", "example": "status" }, { "name": "Tags", "type": "array", "required": false, "description": "配置文件标签数组", "example": "[\"taga\",\"tagb\"]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key-value 键", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "key-value 值", "example": "tom" } ] }, { "name": "CreateTime", "type": "string", "required": false, "description": "配置文件创建时间", "example": "2024-12-29 16:23:00" }, { "name": "CreateBy", "type": "string", "required": false, "description": "配置文件创建者", "example": "usera" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "配置文件修改时间", "example": "2024-12-29 16:23:00" }, { "name": "ModifyBy", "type": "string", "required": false, "description": "配置文件修改者", "example": "usera" }, { "name": "ReleaseTime", "type": "string", "required": false, "description": "配置文件发布时间", "example": "2024-12-29 16:23:00" }, { "name": "ReleaseBy", "type": "string", "required": false, "description": "配置文件发布者", "example": "usera" }, { "name": "ConfigFileSupportedClient", "type": "integer", "required": false, "description": "配置文件类型", "example": "client_sdk" }, { "name": "ConfigFilePersistent", "type": "object", "required": false, "description": "配置文件持久化", "example": "无", "children": [ { "name": "Encoding", "type": "string", "required": false, "description": "文件编码", "example": "UTF-8" }, { "name": "Path", "type": "string", "required": false, "description": "文件下发路径", "example": "/path/var" }, { "name": "PostCmd", "type": "string", "required": false, "description": "文件后置命令", "example": "echo aaa;\\n echo ccc" } ] }, { "name": "Encrypted", "type": "boolean", "required": false, "description": "是否开启加密算法", "example": "true" }, { "name": "EncryptAlgo", "type": "string", "required": false, "description": "加密算法", "example": "AES" } ] } ], "required": [ "InstanceId", "ConfigFile" ] }, { "name": "CreateConfigFileGroup", "description": "创建服务治理中心配置文件组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse 实例 id", "example": "ins-df344df5" }, { "name": "ConfigFileGroup", "type": "object", "required": true, "description": "配置文件组实体", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "配置文件组id", "example": "100" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件组名称", "example": "janice-test" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespaceName" }, { "name": "Comment", "type": "string", "required": false, "description": "备注", "example": "Comment" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2023-03-07 00:00:00" }, { "name": "CreateBy", "type": "string", "required": false, "description": "创建者", "example": "usera" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间", "example": "2023-03-07 00:00:00" }, { "name": "ModifyBy", "type": "string", "required": false, "description": "修改者", "example": "userb" }, { "name": "FileCount", "type": "integer", "required": false, "description": "文件数", "example": "100" }, { "name": "UserIds", "type": "array", "required": false, "description": "关联用户，link_users", "example": "[\"usera\",\"userb\"]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "组id，link_groups", "example": "[\"group-1\"]", "item_type": "string" }, { "name": "RemoveUserIds", "type": "array", "required": false, "description": "remove_link_users", "example": "[\"usera\"]", "item_type": "string" }, { "name": "RemoveGroupIds", "type": "array", "required": false, "description": "remove_link_groups", "example": "[\"group-1\"]", "item_type": "string" }, { "name": "Editable", "type": "boolean", "required": false, "description": "是否可编辑", "example": "true" }, { "name": "Owner", "type": "string", "required": false, "description": "归属者", "example": "usera" }, { "name": "Department", "type": "string", "required": false, "description": "部门", "example": "DepartmentName" }, { "name": "Business", "type": "string", "required": false, "description": "业务", "example": "BusinessName" }, { "name": "ConfigFileGroupTags", "type": "array", "required": false, "description": "配置文件组标签", "example": "[\"taga\"]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key-value 键", "example": "Name" }, { "name": "Value", "type": "string", "required": false, "description": "key-value 值", "example": "Tom" } ] } ] } ], "required": [ "InstanceId", "ConfigFileGroup" ] }, { "name": "CreateEngine", "description": "创建引擎实例", "status": "online", "parameters": [ { "name": "EngineType", "type": "string", "required": true, "description": "引擎类型。参考值： - zookeeper - nacos - consul - apollo - eureka - polaris", "example": "zookeeper" }, { "name": "EngineVersion", "type": "string", "required": true, "description": "引擎的开源版本。每种引擎支持的开源版本不同，请参考产品文档或者控制台购买页", "example": "3.5.9" }, { "name": "EngineProductVersion", "type": "string", "required": true, "description": "引擎的产品版本。参考值： - STANDARD： 标准版 - PROFESSIONAL: 专业版（Zookeeper）/企业版（PolarisMesh） 引擎各版本及可选择的规格、节点数说明： apollo - STANDARD版本 规格列表：1C2G、2C4G、4C8G、8C16G、16C32G 节点数：1，2，3，4，5 eureka - STANDARD版本 规格列表：1C2G、2C4G、4C8G、8C16G、16C32G 节点数：3，4，5 polarismesh - STANDARD版本 规格列表：NUM50、NUM100、NUM200、NUM500、NUM1000、NUM5000、NUM10000、N...", "example": "STANDARD" }, { "name": "EngineRegion", "type": "string", "required": true, "description": "引擎所在地域。参考值说明： 中国区 参考值： - ap-guangzhou：广州 - ap-beijing：北京 - ap-chengdu：成都 - ap-chongqing：重庆 - ap-nanjing：南京 - ap-shanghai：上海 - ap-hongkong：香港 - ap-taipei：台北 亚太区 参考值： - ap-jakarta：雅加达 - ap-singapore：新加坡 北美区 参考值 - na-siliconvalley：硅谷 - na-ashburn: 弗吉尼亚 金融专区 参考值 - ap-beijing-fsi：北京金融 - ap-shanghai-fsi：上海金融 - ap-shenzhen-fsi\ufffd...", "example": "ap-beijing" }, { "name": "EngineName", "type": "string", "required": true, "description": "引擎名称。参考值： - eurek-test", "example": "qzone-photo-prod" }, { "name": "TradeType", "type": "integer", "required": true, "description": "付费类型。参考值： - 0：后付费 - 1：预付费（接口暂不支持创建预付费实例）", "example": "0" }, { "name": "EngineResourceSpec", "type": "string", "required": false, "description": "引擎的节点规格 ID。参见EngineProductVersion字段说明 北极星支持的引擎规格ID与节点数对应关系： 基础版： spec-c160bas1 500 spec-c160bas2 1000 spec-c160bas3 2000 spec-c160bas4 5000 spec-c160bas5 10000 spec-c160bas6 20000 spec-c160bas7 50000 企业版： spec-c160pro50 50 spec-c160pro100 100 spec-c160pro200 200 spec-c160pro500 500 spec-c160pro1k 1000 spec-c160pro5k 5000 spec-c160pro10k 10000 spec-c160pro20k 20000 spec-c160pro50k 50000 开发版： spec-c160dev1 50", "example": "1C2G" }, { "name": "EngineNodeNum", "type": "integer", "required": false, "description": "引擎的节点数量。参见EngineProductVersion字段说明", "example": "3" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC ID。在 VPC 的子网内分配一个 IP 作为引擎的访问地址。参考值： - vpc-conz6aix", "example": "vpc-xxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网 ID。在 VPC 的子网内分配一个 IP 作为引擎的访问地址。参考值： - subnet-ahde9me9", "example": "subnet-xxxxxx" }, { "name": "ApolloEnvParams", "type": "array", "required": false, "description": "Apollo 环境配置参数列表。参数说明： 如果创建Apollo类型，此参数为必填的环境信息列表，最多可选4个环境。环境信息参数说明： - Name：环境名。参考值：prod, dev, fat, uat - EngineResourceSpec：环境内引擎的节点规格ID。参见EngineProductVersion参数说明 - EngineNodeNum：环境内引擎的节点数量。参见EngineProductVersion参数说明，其中prod环境支持的节点数为2，3，4，5 - StorageCapacity：配置存储空...", "example": "[{\"EnvName\":\"pro\",\"StorageCapacity\":50,\"EngineResourceSpec\":\"spec-xxx\",\"EngineNodeNum\":1}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "环境名称", "example": "prod" }, { "name": "EngineResourceSpec", "type": "string", "required": true, "description": "环境内引擎的节点规格 ID -1C2G -2C4G 兼容原spec-xxxxxx形式的规格ID", "example": "1C2G" }, { "name": "EngineNodeNum", "type": "integer", "required": true, "description": "环境内引擎的节点数量", "example": "3" }, { "name": "StorageCapacity", "type": "integer", "required": true, "description": "配置存储空间大小，以GB为单位", "example": "50" }, { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID。在 VPC 的子网内分配一个 IP 作为 ConfigServer 的访问地址", "example": "vpc-xxxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网 ID。在 VPC 的子网内分配一个 IP 作为 ConfigServer 的访问地址", "example": "subnet-xxxxxx" }, { "name": "EnvDesc", "type": "string", "required": false, "description": "环境描述", "example": "envDesc" } ] }, { "name": "EngineTags", "type": "array", "required": false, "description": "引擎的标签列表。用户自定义的key/value形式，无参考值", "example": "[{\"key\":\"value\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "value" } ] }, { "name": "EngineAdmin", "type": "object", "required": false, "description": "引擎的初始账号信息。可设置参数： - Name：控制台初始用户名 - Password：控制台初始密码 - Token：引擎接口的管理员 Token", "example": "{\"Name\":\"nacos\",\"Password\":\"xxxxxx\",\"Token\":\"xxxxxx\"}", "children": [ { "name": "Name", "type": "string", "required": false, "description": "控制台初始用户名", "example": "nacos" }, { "name": "Password", "type": "string", "required": false, "description": "控制台初始密码", "example": "password" }, { "name": "Token", "type": "string", "required": false, "description": "引擎接口的管理员 Token", "example": "token" } ] }, { "name": "PrepaidPeriod", "type": "integer", "required": false, "description": "预付费时长，以月为单位", "example": "1" }, { "name": "PrepaidRenewFlag", "type": "integer", "required": false, "description": "自动续费标记，仅预付费使用。参考值： - 0：不自动续费 - 1：自动续费", "example": "0" }, { "name": "EngineRegionInfos", "type": "array", "required": false, "description": "跨地域部署的引擎地域配置详情 zk标准版没有跨地域部署，请不要填写 zk专业版跨地域部署开启了固定Leader所在地域，需要满足以下条件 - 固定Leader所在地域当前仅支持跨两个地域 - leader地域的副本数必须是3/2 + 1，5/2+1，7/2+1，也就是 2，3，4", "example": "[{\"EngineRegion\":\"ap-guangzhou\",\"Replica\":2,\"SpecId\":\"1C2G\",\"VpcInfos\":[{\"VpcId\":\"vpc-XXX\",\"SubnetId\":\"subnet-XXX\"}]},{\"EngineRegion\":\"ap-beijing\",\"Replica\":1,\"SpecId\":\"1C2G\",\"VpcInfos\":[{\"VpcId\":\"vpc-XXX\",\"SubnetId\":\"subnet-XXX\"}]}]", "item_type": "object", "children": [ { "name": "EngineRegion", "type": "string", "required": true, "description": "引擎节点所在地域", "example": "ap-guangzhou" }, { "name": "Replica", "type": "integer", "required": true, "description": "此地域节点分配数量", "example": "2" }, { "name": "VpcInfos", "type": "array", "required": true, "description": "集群网络信息", "example": "[{\"VpcId\":\"vpc-XXX\",\"SubnetId\":\"subnet-XXX\"}]", "item_type": "object", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "Vpc Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网ID", "example": "subnet-xxxxxxxx" }, { "name": "IntranetAddress", "type": "string", "required": false, "description": "内网访问地址", "example": "xxxx.xx.xx.xx" }, { "name": "LbSubnetId", "type": "string", "required": false, "description": "负载均衡均衡接入点子网ID", "example": "subnet-xxxxxxxx" } ] }, { "name": "MainRegion", "type": "boolean", "required": false, "description": "Polaris: 是否为主地域 Zookeeper: 是否为Leader固定地域", "example": "true" }, { "name": "SpecId", "type": "string", "required": false, "description": "引擎规格ID", "example": "SPEC_1C2G" } ] }, { "name": "StorageType", "type": "string", "required": false, "description": "zk标准版请填CLOUD_PREMIUM，zk标准版无法选择磁盘类型和磁盘容量，默认为CLOUD_PREMIUM zk专业版可以为：CLOUD_SSD,CLOUD_SSD_PLUS,CLOUD_PREMIUM", "example": "CLOUD_SSD" }, { "name": "StorageCapacity", "type": "integer", "required": false, "description": "zk标准版请填50，zk标准版无法选择磁盘类型和磁盘容量，磁盘容量默认为50", "example": "50" }, { "name": "StorageOption", "type": "array", "required": false, "description": "zk专业版至多有两个盘，且磁盘的容量在50-3200之间 如果只有一个磁盘，storageCapacity与storageOption里面的capacity应该一致", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "存储对象，分为snap和txn两种", "example": "snap" }, { "name": "Type", "type": "string", "required": false, "description": "存储类型，分为三类CLOUD_PREMIUM/CLOUD_SSD/CLOUD_SSD_PLUS，分别对应高性能云硬盘、SSD云硬盘、增强型SSD云硬盘", "example": "CLOUD_PREMIUM" }, { "name": "Capacity", "type": "integer", "required": false, "description": "存储容量，[50, 3200]的范围", "example": "50" } ] }, { "name": "AffinityConstraint", "type": "string", "required": false, "description": "ZK引擎实例，可用区分布约束，STRICT:强约束，PERMISSIVE: 弱约束", "example": "STRICT" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "指定zone id列表", "example": "[100006,100007]", "item_type": "integer" }, { "name": "EngineRegionTag", "type": "string", "required": false, "description": "地域特殊标签，用于区分相同地域，不通的业务属性", "example": "ziyan_fit" } ], "required": [ "EngineType", "EngineVersion", "EngineProductVersion", "EngineRegion", "EngineName", "TradeType" ] }, { "name": "CreateGovernanceAlias", "description": "创建治理中心服务别名", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "Alias", "type": "string", "required": true, "description": "服务别名", "example": "TestSvcAlias" }, { "name": "AliasNamespace", "type": "string", "required": true, "description": "服务别名命名空间", "example": "Production" }, { "name": "Service", "type": "string", "required": true, "description": "服务别名所指向的服务名", "example": "TestSvc" }, { "name": "Namespace", "type": "string", "required": true, "description": "服务别名所指向的命名空间", "example": "default" }, { "name": "Comment", "type": "string", "required": false, "description": "服务别名描述", "example": "comment" } ], "required": [ "InstanceId", "Alias", "AliasNamespace", "Service", "Namespace" ] }, { "name": "CreateGovernanceInstances", "description": "创建服务实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "GovernanceInstances", "type": "array", "required": true, "description": "服务实例信息。", "example": "无", "item_type": "object", "children": [ { "name": "Service", "type": "string", "required": true, "description": "实例所在服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": true, "description": "实例服务所在命名空间。", "example": "Development" }, { "name": "Weight", "type": "integer", "required": false, "description": "实例负载均衡权重信息。不填默认为100。", "example": "100" }, { "name": "Healthy", "type": "boolean", "required": false, "description": "实例默认健康信息。不填默认为健康。", "example": "true" }, { "name": "Isolate", "type": "boolean", "required": false, "description": "实例隔离信息。不填默认为非隔离。", "example": "true" }, { "name": "Host", "type": "string", "required": false, "description": "实例ip。", "example": "192.168.1.1" }, { "name": "Port", "type": "integer", "required": false, "description": "实例监听端口。", "example": "8080" }, { "name": "Protocol", "type": "string", "required": false, "description": "实例使用协议。不填默认为空。", "example": "grpc" }, { "name": "InstanceVersion", "type": "string", "required": false, "description": "实例版本。不填默认为空。", "example": "v1" }, { "name": "EnableHealthCheck", "type": "boolean", "required": false, "description": "是否启用健康检查。不填默认不启用。", "example": "true" }, { "name": "Ttl", "type": "integer", "required": false, "description": "上报心跳时间间隔。若 EnableHealthCheck 为不启用，则此参数不生效；若 EnableHealthCheck 启用，此参数不填，则默认 ttl 为 5s。", "example": "5" } ] } ], "required": [ "InstanceId", "GovernanceInstances" ] }, { "name": "CreateGovernanceLaneGroups", "description": "创建泳道组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "引擎实例ID", "example": "ins-123" }, { "name": "LaneGroups", "type": "array", "required": true, "description": "泳道组规则列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "泳道名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "lanegroup-123" }, { "name": "ID", "type": "string", "required": false, "description": "泳道组ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "123345" }, { "name": "TrafficEntries", "type": "array", "required": false, "description": "泳道入口服务列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "EntryType", "type": "string", "required": false, "description": "// type == \"polarismesh.cn/gateway/tse-gateway, 则 selector 为 TSEGatewaySelector // type == \"polarismesh.cn/gateway/spring-cloud-gateway\", 则 selector 为 ServiceGatewaySelector // type == \"polarismesh.cn/service, 则 selector 为 ServiceSelector 注意：此字段可能返回 null，表示取不到有效值。", "example": "polarismesh.cn/gateway/tse-gateway" }, { "name": "TSEGatewaySelector", "type": "object", "required": false, "description": "TSE云原生网关选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关引擎实例ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "gateway-123456" }, { "name": "Services", "type": "array", "required": false, "description": "网关服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"service-1\"]", "item_type": "string" } ] }, { "name": "ServiceGatewaySelector", "type": "object", "required": false, "description": "微服务网关选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ServiceSelector", "type": "object", "required": false, "description": "普通微服务选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ] }, { "name": "Destinations", "type": "array", "required": false, "description": "泳道服务列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "namespace" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "LabelKey", "type": "string", "required": false, "description": "标签键 注意：此字段可能返回 null，表示取不到有效值。", "example": "labelkey1" }, { "name": "LabelValue", "type": "string", "required": false, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "value" }, { "name": "LabelType", "type": "string", "required": false, "description": "表达式类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOT_IN" }, { "name": "LabelValueType", "type": "string", "required": false, "description": "值类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" } ] } ] }, { "name": "Description", "type": "string", "required": false, "description": "泳道组描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "123123" }, { "name": "Rules", "type": "array", "required": false, "description": "该泳道组下的所有泳道规则列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ID", "type": "string", "required": false, "description": "泳道规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "71f28761f5e8433a9e656fb290e1dcf8" }, { "name": "Name", "type": "string", "required": false, "description": "泳道名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "rule-1" }, { "name": "LaneGroup", "type": "string", "required": false, "description": "泳道所属泳道组 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-2" }, { "name": "Enable", "type": "boolean", "required": false, "description": "泳道规则启用状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "TrafficLabels", "type": "array", "required": false, "description": "流量标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "CALLER_IP" }, { "name": "Key", "type": "string", "required": false, "description": "key值 注意：此字段可能返回 null，表示取不到有效值。", "example": "$caller_ip" }, { "name": "Value", "type": "object", "required": false, "description": "匹配条件参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ \t\t\t\t\t\t\"type\": \"EXACT\", \t\t\t\t\t\t\"value\": \"test\", \t\t\t\t\t\t\"value_type\": \"TEXT\" \t\t\t\t\t}" } ] }, { "name": "TrafficMatchMode", "type": "string", "required": false, "description": "多个流量标签匹配方式 AND：与 OR：或 注意：此字段可能返回 null，表示取不到有效值。", "example": "AND|OR" }, { "name": "LaneMatchMode", "type": "string", "required": false, "description": "泳道匹配方式 STRICT：严格匹配 PERMISSIVE：宽松匹配 注意：此字段可能返回 null，表示取不到有效值。", "example": "STRICT|PERMISSIVE" }, { "name": "TrafficGray", "type": "object", "required": false, "description": "泳道灰度规则", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "流量灰度规则，按比例灰度或预热方式", "example": "PERCENTAGE" }, { "name": "Percent", "type": "integer", "required": false, "description": "按比例灰度的百分比值1-100", "example": "30" }, { "name": "IntervalSecond", "type": "integer", "required": false, "description": "预热的间隔", "example": "6" }, { "name": "Curvature", "type": "integer", "required": false, "description": "预热的曲度", "example": "2" } ] }, { "name": "Description", "type": "string", "required": false, "description": "泳道规则描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "blue" }, { "name": "LaneLabelValue", "type": "string", "required": false, "description": "泳道标签内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "gray" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "EnableTime", "type": "string", "required": false, "description": "启用时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "Priority", "type": "integer", "required": false, "description": "泳道规则优先级 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Revision", "type": "string", "required": false, "description": "规则摘要 注意：此字段可能返回 null，表示取不到有效值。", "example": "df5bc49fd0084bf3a362b5152d52ad8a" } ] }, { "name": "Revision", "type": "string", "required": false, "description": "规则内容摘要 注意：此字段可能返回 null，表示取不到有效值。", "example": "c123xaweqw" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "Consistency", "type": "string", "required": false, "description": "规则一致性状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "Abnormal/Normal/Unknown" } ] } ], "required": [ "InstanceId", "LaneGroups" ] }, { "name": "CreateGovernanceNamespaces", "description": "创建治理中心命名空间", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse 实例id。", "example": "ins-df344df5" }, { "name": "GovernanceNamespaces", "type": "array", "required": true, "description": "命名空间信息。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "命名空间名。", "example": "Development" }, { "name": "Comment", "type": "string", "required": false, "description": "描述信息。", "example": "开发环境" }, { "name": "UserIds", "type": "array", "required": false, "description": "新增的可以操作此命名空间的用户ID列表", "example": "[1,2,3,4]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "新增的可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveUserIds", "type": "array", "required": false, "description": "移除可以操作此命名空间的用户ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveGroupIds", "type": "array", "required": false, "description": "移除可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "ServiceExportTo", "type": "array", "required": false, "description": "该命名空间下的服务对哪些命名空间下可见， 1、为空或者不填写，表示仅当前命名空间可见 2、列表内容仅一个元素，且为字符 *，表示所有命名空间可见（包括新增） 3、列表内容为部份命名空间名称，则只对这些命名空间下可见", "example": "[Namespace-1, Namespace-2]", "item_type": "string" }, { "name": "SyncToGlobalRegistry", "type": "boolean", "required": false, "description": "是否开启同步到全局注册中心", "example": "false" } ] } ], "required": [ "InstanceId", "GovernanceNamespaces" ] }, { "name": "CreateGovernanceServices", "description": "创建治理中心服务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse 实例 id。", "example": "ins-df344df5" }, { "name": "GovernanceServices", "type": "array", "required": true, "description": "服务信息。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": true, "description": "服务所属命名空间。", "example": "Development" }, { "name": "Comment", "type": "string", "required": false, "description": "服务描述信息。", "example": "生产者服务。" }, { "name": "Metadatas", "type": "array", "required": false, "description": "服务元数据。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] }, { "name": "Department", "type": "string", "required": false, "description": "服务所属部门。", "example": "市场部" }, { "name": "Business", "type": "string", "required": false, "description": "服务所属业务。", "example": "采购业务" }, { "name": "UserIds", "type": "array", "required": false, "description": "被添加进来可以操作此命名空间的用户ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "被添加进来可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveUserIds", "type": "array", "required": false, "description": "从操作此命名空间的用户组ID列表被移除的ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveGroupIds", "type": "array", "required": false, "description": "从可以操作此命名空间的用户组ID列表中被移除的ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "ExportTo", "type": "array", "required": false, "description": "该服务对哪些命名空间可见", "example": "[Namespace-1,Namespace-2]", "item_type": "string" }, { "name": "SyncToGlobalRegistry", "type": "boolean", "required": false, "description": "是否开启同步到全局注册中心", "example": "false" } ] } ], "required": [ "InstanceId", "GovernanceServices" ] }, { "name": "CreateNativeGatewayServerGroup", "description": "创建云原生网关引擎分组", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例id。 只支持后付费实例", "example": "gateway-sadf1234" }, { "name": "Name", "type": "string", "required": true, "description": "网关分组名", "example": "prod" }, { "name": "NodeConfig", "type": "object", "required": true, "description": "节点配置", "example": "无", "children": [ { "name": "Specification", "type": "string", "required": true, "description": "节点配置, 1c2g|2c4g|4c8g|8c16g。", "example": "1c2g" }, { "name": "Number", "type": "integer", "required": true, "description": "节点数量，2-9。", "example": "2" } ] }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网id", "example": "subnet-a1vba21z" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息", "example": "正式环境" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网带宽信息", "example": "30" }, { "name": "InternetConfig", "type": "object", "required": false, "description": "公网配置。", "example": "无", "children": [ { "name": "InternetAddressVersion", "type": "string", "required": false, "description": "公网地址版本，可选：\"IPV4\" | \"IPV6\" 。不填默认 IPV4 。", "example": "IPV6" }, { "name": "InternetPayMode", "type": "string", "required": false, "description": "公网付费类型，当前仅可选：\"BANDWIDTH\"。不填默认为 \"BANDWIDTH\"", "example": "BANDWIDTH" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网带宽。", "example": "5" }, { "name": "Description", "type": "string", "required": false, "description": "负载均衡描述", "example": "公网入口" }, { "name": "SlaType", "type": "string", "required": false, "description": "负载均衡的规格类型，支持clb.c2.medium、clb.c3.small、clb.c3.medium、clb.c4.small、clb.c4.medium、clb.c4.large、clb.c4.xlarge，不传为共享型。", "example": "clb.c4.small" }, { "name": "MultiZoneFlag", "type": "boolean", "required": false, "description": "负载均衡是否多可用区", "example": "false" }, { "name": "MasterZoneId", "type": "string", "required": false, "description": "主可用区", "example": "ap-guangzhou-1" }, { "name": "SlaveZoneId", "type": "string", "required": false, "description": "备可用区", "example": "ap-guangzhou-3" } ] } ], "required": [ "GatewayId", "Name", "NodeConfig", "SubnetId" ] }, { "name": "CreateNativeGatewayServiceSource", "description": "创建网关服务来源", "status": "online", "parameters": [ { "name": "GatewayID", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-dde03567" }, { "name": "SourceType", "type": "string", "required": true, "description": "服务来源类型，参考值： - TSE-Nacos - TSE-Consul - TSE-PolarisMesh - Customer-Nacos - Customer-Consul - Customer-PolarisMesh - TSF - TKE - EKS - PrivateDNS - Customer-DNS", "example": "TSE-Nacos" }, { "name": "SourceID", "type": "string", "required": false, "description": "服务来源实例ID，当SourceType的值不为PrivateDNS或Customer-DNS时，必填", "example": "ins-5ef8277d" }, { "name": "SourceName", "type": "string", "required": false, "description": "服务来源实例名称，当SourceType的值不为PrivateDNS时，必填", "example": "nacos-learn-prod" }, { "name": "SourceInfo", "type": "object", "required": false, "description": "服务来源实例额外信息", "example": "无", "children": [ { "name": "Addresses", "type": "array", "required": false, "description": "微服务引擎接入IP地址信息", "example": "[\"127.0.0.1:8080\"]", "item_type": "string" }, { "name": "VpcInfo", "type": "object", "required": false, "description": "微服务引擎VPC信息", "example": "无", "children": [ { "name": "VpcID", "type": "string", "required": false, "description": "微服务引擎VPC信息", "example": "vpc-id" }, { "name": "SubnetID", "type": "string", "required": false, "description": "微服务引擎子网信息", "example": "subnet-id" } ] }, { "name": "Auth", "type": "object", "required": false, "description": "微服务引擎鉴权信息", "example": "无", "children": [ { "name": "Username", "type": "string", "required": false, "description": "用户名", "example": "tse" }, { "name": "Password", "type": "string", "required": false, "description": "账户密码", "example": "tse" }, { "name": "AccessToken", "type": "string", "required": false, "description": "访问凭据 token", "example": "tse" } ] } ] } ], "required": [ "GatewayID", "SourceType" ] }, { "name": "CreateOrModifyCloudNativeAPIGatewayIPRestriction", "description": "创建或编辑云原生网关访问控制", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "SourceType", "type": "string", "required": true, "description": "访问控制插件绑定的资源类型：route|service", "example": "route" }, { "name": "SourceId", "type": "string", "required": true, "description": "路由或服务的id", "example": "31f3bf99-f289-4b6e-8edc-5e09d9d8ce4e" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "是否启用插件", "example": "true" }, { "name": "RestrictionType", "type": "string", "required": true, "description": "访问控制类型：whiteList｜blackList", "example": "whiteList" }, { "name": "AddressList", "type": "array", "required": true, "description": "cidr｜ip", "example": "[1.1.1.1,2.2.2.2]", "item_type": "string" } ], "required": [ "GatewayId", "SourceType", "SourceId", "Enabled", "RestrictionType", "AddressList" ] }, { "name": "CreateOrUpdateConfigFileAndRelease", "description": "创建或更新配置文件并发布配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "ins-0e02e26d" }, { "name": "ConfigFilePublishInfo", "type": "object", "required": true, "description": "配置文件列表详情", "example": "无", "children": [ { "name": "ReleaseName", "type": "string", "required": false, "description": "发布名称", "example": "v1" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespaceName" }, { "name": "Group", "type": "string", "required": false, "description": "发布组", "example": "privoder-demo" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名", "example": "application.yml" }, { "name": "Content", "type": "string", "required": false, "description": "内容", "example": "hello" }, { "name": "Comment", "type": "string", "required": false, "description": "描述", "example": "comment" }, { "name": "Format", "type": "string", "required": false, "description": "格式", "example": "yaml" }, { "name": "CreateBy", "type": "string", "required": false, "description": "创建者", "example": "usera" }, { "name": "ModifyBy", "type": "string", "required": false, "description": "修改者", "example": "usera" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key-value 键", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "key-value 值", "example": "tom" } ] } ] }, { "name": "StrictEnable", "type": "boolean", "required": false, "description": "控制开启校验配置版本是否已经存在", "example": "true" } ], "required": [ "InstanceId", "ConfigFilePublishInfo" ] }, { "name": "CreateWafDomains", "description": "新建 WAF 防护域名", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Domains", "type": "array", "required": true, "description": "WAF 防护域名列表", "example": "[\"tencent.com\"]", "item_type": "string" } ], "required": [ "GatewayId", "Domains" ] }, { "name": "DeleteAutoScalerResourceStrategy", "description": "删除弹性伸缩策略", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-4a34cf5f" }, { "name": "StrategyId", "type": "string", "required": true, "description": "策略ID", "example": "strategy-7bb4fcb0" } ], "required": [ "GatewayId", "StrategyId" ] }, { "name": "DeleteCloudNativeAPIGateway", "description": "删除云原生API网关实例", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxxxx" }, { "name": "DeleteClsTopic", "type": "boolean", "required": false, "description": "是否删除实例关联的 CLS 日志主题。", "example": "true" } ], "required": [ "GatewayId" ] }, { "name": "DeleteCloudNativeAPIGatewayCanaryRule", "description": "删除云原生网关的灰度规则", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID", "example": "gateway-962b7d7c" }, { "name": "ServiceId", "type": "string", "required": true, "description": "服务 ID", "example": "service-xxx" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级", "example": "10" }, { "name": "PriorityList", "type": "array", "required": false, "description": "优先级列表，如果配置了此参数，将以此参数为准，忽略Priority参数", "example": "[10,20]", "item_type": "integer" } ], "required": [ "GatewayId", "ServiceId" ] }, { "name": "DeleteCloudNativeAPIGatewayCertificate", "description": "删除云原生网关证书", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Id", "type": "string", "required": true, "description": "证书Id", "example": "6190e57f-f5b2-4295-a8c0-34d4a6d0e6e5" } ], "required": [ "GatewayId", "Id" ] }, { "name": "DeleteCloudNativeAPIGatewayIPRestriction", "description": "删除云原生网关访问控制", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "SourceType", "type": "string", "required": true, "description": "访问控制插件绑定的资源类型：route|service", "example": "route" }, { "name": "SourceId", "type": "string", "required": true, "description": "路由或服务的id", "example": "31f3bf99-f289-4b6e-8edc-5e09d9d8ce4e" } ], "required": [ "GatewayId", "SourceType", "SourceId" ] }, { "name": "DeleteCloudNativeAPIGatewayPublicNetwork", "description": "删除公网网络配置", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxx1234" }, { "name": "GroupId", "type": "string", "required": false, "description": "分组id，kong类型时必填", "example": "group-xxxx1234" }, { "name": "InternetAddressVersion", "type": "string", "required": false, "description": "公网类型 - IPV4 （默认值） - IPV6", "example": "IPV6" }, { "name": "Vip", "type": "string", "required": false, "description": "公网ip，存在多个公网时必填", "example": "129.0.0.1" } ], "required": [ "GatewayId" ] }, { "name": "DeleteCloudNativeAPIGatewayRoute", "description": "删除云原生网关路由", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "路由的ID或名字，不支持名称“未命名”", "example": "451a9920-e67a-4519-af41-fccac0e72005" } ], "required": [ "GatewayId", "Name" ] }, { "name": "DeleteCloudNativeAPIGatewayRouteRateLimit", "description": "删除云原生网关的限流插件(路由)", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关Id", "example": "gateway-962b7d7c" }, { "name": "Id", "type": "string", "required": true, "description": "路由Id，或路由名称。 不支持“未命名”", "example": "6f423439-ec27-4a2e-aff9-9e73ffa3da4" } ], "required": [ "GatewayId", "Id" ] }, { "name": "DeleteCloudNativeAPIGatewayService", "description": "删除云原生网关服务", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "服务名字，服务ID", "example": "service-demo" }, { "name": "DeleteRoutes", "type": "boolean", "required": false, "description": "是否同步删除服务上绑定的路由", "example": "false" } ], "required": [ "GatewayId", "Name" ] }, { "name": "DeleteCloudNativeAPIGatewayServiceRateLimit", "description": "删除云原生网关的限流插件(服务)", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关Id", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "服务名称，或服务ID", "example": "service-demo" } ], "required": [ "GatewayId", "Name" ] }, { "name": "DeleteConfigFileGroup", "description": "删除配置文件分组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse 实例 id。", "example": "ins-df344df5\t" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "namespace" }, { "name": "Group", "type": "string", "required": true, "description": "组", "example": "group" } ], "required": [ "InstanceId", "Namespace", "Group" ] }, { "name": "DeleteConfigFileReleases", "description": "删除配置发布", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "ins-0e02e26d" }, { "name": "ConfigFileReleases", "type": "array", "required": true, "description": "待删除配置发布详情", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespaceName" }, { "name": "Group", "type": "string", "required": false, "description": "配置分组", "example": "provider-demo" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名称", "example": "application,yml" }, { "name": "ReleaseVersion", "type": "string", "required": false, "description": "发布版本", "example": "v1.0" }, { "name": "Id", "type": "integer", "required": false, "description": "配置发布ID", "example": "1" } ] } ], "required": [ "InstanceId", "ConfigFileReleases" ] }, { "name": "DeleteConfigFiles", "description": "删除配置文件", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE实例id", "example": "ins-df344df5\t" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespace" }, { "name": "Group", "type": "string", "required": false, "description": "配置分组名称", "example": "group" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件名称", "example": "name" }, { "name": "Id", "type": "string", "required": false, "description": "配置文件Id", "example": "1" } ], "required": [ "InstanceId" ] }, { "name": "DeleteEngine", "description": "删除引擎实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "引擎实例 ID", "example": "ins-12345678" } ], "required": [ "InstanceId" ] }, { "name": "DeleteGovernanceAliases", "description": "删除治理中心服务别名", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "GovernanceAliases", "type": "array", "required": true, "description": "服务别名列表", "example": "无", "item_type": "object", "children": [ { "name": "Alias", "type": "string", "required": false, "description": "服务别名", "example": "TestSvcAlias" }, { "name": "AliasNamespace", "type": "string", "required": false, "description": "服务别名命名空间", "example": "Production" }, { "name": "Service", "type": "string", "required": false, "description": "服务别名指向的服务名", "example": "TestSvc" }, { "name": "Namespace", "type": "string", "required": false, "description": "服务别名指向的服务命名空间", "example": "default" }, { "name": "Comment", "type": "string", "required": false, "description": "服务别名的描述信息", "example": "comment" }, { "name": "CreateTime", "type": "string", "required": false, "description": "服务别名创建时间", "example": "2021-11-12 12:14:00" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "服务别名修改时间", "example": "2021-11-12 12:14:00" }, { "name": "Id", "type": "string", "required": false, "description": "服务别名ID", "example": "1" }, { "name": "Editable", "type": "boolean", "required": false, "description": "该服务别名是否可以编辑", "example": "true" }, { "name": "Metadatas", "type": "array", "required": false, "description": "元数据信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] } ] } ], "required": [ "InstanceId", "GovernanceAliases" ] }, { "name": "DeleteGovernanceInstances", "description": "删除服务实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "GovernanceInstances", "type": "array", "required": true, "description": "要删除的服务实例信息。", "example": "无", "item_type": "object", "children": [ { "name": "Service", "type": "string", "required": true, "description": "实例所在服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": true, "description": "实例服务所在命名空间。", "example": "Development" }, { "name": "Weight", "type": "integer", "required": false, "description": "实例负载均衡权重信息。不填默认为100。", "example": "100" }, { "name": "Healthy", "type": "boolean", "required": false, "description": "实例默认健康信息。不填默认为健康。", "example": "true" }, { "name": "Isolate", "type": "boolean", "required": false, "description": "实例隔离信息。不填默认为非隔离。", "example": "true" }, { "name": "Host", "type": "string", "required": false, "description": "实例ip。", "example": "192.168.1.1" }, { "name": "Port", "type": "integer", "required": false, "description": "实例监听端口。", "example": "8080" }, { "name": "Protocol", "type": "string", "required": false, "description": "实例使用协议。不填默认为空。", "example": "grpc" }, { "name": "InstanceVersion", "type": "string", "required": false, "description": "实例版本。不填默认为空。", "example": "v1" }, { "name": "EnableHealthCheck", "type": "boolean", "required": false, "description": "是否启用健康检查。不填默认不启用。", "example": "true" }, { "name": "Ttl", "type": "integer", "required": false, "description": "上报心跳时间间隔。若 EnableHealthCheck 为不启用，则此参数不生效；若 EnableHealthCheck 启用，此参数不填，则默认 ttl 为 5s。", "example": "5" }, { "name": "Id", "type": "string", "required": false, "description": "治理中心服务实例id。", "example": "0662cc4b73fae0a4b911363f25a51e3434de0d8c343" }, { "name": "Metadatas", "type": "array", "required": false, "description": "元数据信息。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] } ] } ], "required": [ "InstanceId", "GovernanceInstances" ] }, { "name": "DeleteGovernanceInstancesByHost", "description": "删除治理中心服务实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "GovernanceInstances", "type": "array", "required": true, "description": "要删除的服务实例信息。", "example": "无", "item_type": "object", "children": [ { "name": "Service", "type": "string", "required": true, "description": "实例所在服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": true, "description": "实例服务所在命名空间。", "example": "Development" }, { "name": "Weight", "type": "integer", "required": false, "description": "实例负载均衡权重信息。不填默认为100。", "example": "100" }, { "name": "Healthy", "type": "boolean", "required": false, "description": "实例默认健康信息。不填默认为健康。", "example": "true" }, { "name": "Isolate", "type": "boolean", "required": false, "description": "实例隔离信息。不填默认为非隔离。", "example": "true" }, { "name": "Host", "type": "string", "required": false, "description": "实例ip。", "example": "192.168.1.1" }, { "name": "Port", "type": "integer", "required": false, "description": "实例监听端口。", "example": "8080" }, { "name": "Protocol", "type": "string", "required": false, "description": "实例使用协议。不填默认为空。", "example": "grpc" }, { "name": "InstanceVersion", "type": "string", "required": false, "description": "实例版本。不填默认为空。", "example": "v1" }, { "name": "EnableHealthCheck", "type": "boolean", "required": false, "description": "是否启用健康检查。不填默认不启用。", "example": "true" }, { "name": "Ttl", "type": "integer", "required": false, "description": "上报心跳时间间隔。若 EnableHealthCheck 为不启用，则此参数不生效；若 EnableHealthCheck 启用，此参数不填，则默认 ttl 为 5s。", "example": "5" }, { "name": "Id", "type": "string", "required": false, "description": "治理中心服务实例id。", "example": "0662cc4b73fae0a4b911363f25a51e3434de0d8c343" }, { "name": "Metadatas", "type": "array", "required": false, "description": "元数据信息。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] } ] } ], "required": [ "InstanceId", "GovernanceInstances" ] }, { "name": "DeleteGovernanceLaneGroups", "description": "删除泳道组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "引擎实例ID", "example": "ins-123" }, { "name": "LaneGroups", "type": "array", "required": true, "description": "泳道组规则列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "泳道名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "lanegroup-123" }, { "name": "ID", "type": "string", "required": false, "description": "泳道组ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "123345" }, { "name": "TrafficEntries", "type": "array", "required": false, "description": "泳道入口服务列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "EntryType", "type": "string", "required": false, "description": "// type == \"polarismesh.cn/gateway/tse-gateway, 则 selector 为 TSEGatewaySelector // type == \"polarismesh.cn/gateway/spring-cloud-gateway\", 则 selector 为 ServiceGatewaySelector // type == \"polarismesh.cn/service, 则 selector 为 ServiceSelector 注意：此字段可能返回 null，表示取不到有效值。", "example": "polarismesh.cn/gateway/tse-gateway" }, { "name": "TSEGatewaySelector", "type": "object", "required": false, "description": "TSE云原生网关选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关引擎实例ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "gateway-123456" }, { "name": "Services", "type": "array", "required": false, "description": "网关服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"service-1\"]", "item_type": "string" } ] }, { "name": "ServiceGatewaySelector", "type": "object", "required": false, "description": "微服务网关选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ServiceSelector", "type": "object", "required": false, "description": "普通微服务选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ] }, { "name": "Destinations", "type": "array", "required": false, "description": "泳道服务列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "namespace" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "LabelKey", "type": "string", "required": false, "description": "标签键 注意：此字段可能返回 null，表示取不到有效值。", "example": "labelkey1" }, { "name": "LabelValue", "type": "string", "required": false, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "value" }, { "name": "LabelType", "type": "string", "required": false, "description": "表达式类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOT_IN" }, { "name": "LabelValueType", "type": "string", "required": false, "description": "值类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" } ] } ] }, { "name": "Description", "type": "string", "required": false, "description": "泳道组描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "123123" }, { "name": "Revision", "type": "string", "required": false, "description": "规则内容摘要 注意：此字段可能返回 null，表示取不到有效值。", "example": "c123xaweqw" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "Consistency", "type": "string", "required": false, "description": "规则一致性状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "Abnormal/Normal/Unknown" }, { "name": "Rules", "type": "array", "required": false, "description": "泳道规则列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ID", "type": "string", "required": false, "description": "泳道规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "71f28761f5e8433a9e656fb290e1dcf8" }, { "name": "Name", "type": "string", "required": false, "description": "泳道名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "rule-1" }, { "name": "LaneGroup", "type": "string", "required": false, "description": "泳道所属泳道组 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-2" }, { "name": "Enable", "type": "boolean", "required": false, "description": "泳道规则启用状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "TrafficLabels", "type": "array", "required": false, "description": "流量标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "CALLER_IP" }, { "name": "Key", "type": "string", "required": false, "description": "key值 注意：此字段可能返回 null，表示取不到有效值。", "example": "$caller_ip" }, { "name": "Value", "type": "object", "required": false, "description": "匹配条件参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ \t\t\t\t\t\t\"type\": \"EXACT\", \t\t\t\t\t\t\"value\": \"test\", \t\t\t\t\t\t\"value_type\": \"TEXT\" \t\t\t\t\t}" } ] }, { "name": "TrafficMatchMode", "type": "string", "required": false, "description": "多个流量标签匹配方式 AND：与 OR：或 注意：此字段可能返回 null，表示取不到有效值。", "example": "AND|OR" }, { "name": "LaneMatchMode", "type": "string", "required": false, "description": "泳道匹配方式 STRICT：严格匹配 PERMISSIVE：宽松匹配 注意：此字段可能返回 null，表示取不到有效值。", "example": "STRICT|PERMISSIVE" }, { "name": "TrafficGray", "type": "object", "required": false, "description": "泳道灰度规则", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "流量灰度规则，按比例灰度或预热方式", "example": "PERCENTAGE" }, { "name": "Percent", "type": "integer", "required": false, "description": "按比例灰度的百分比值1-100", "example": "30" }, { "name": "IntervalSecond", "type": "integer", "required": false, "description": "预热的间隔", "example": "6" }, { "name": "Curvature", "type": "integer", "required": false, "description": "预热的曲度", "example": "2" } ] }, { "name": "Description", "type": "string", "required": false, "description": "泳道规则描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "blue" }, { "name": "LaneLabelValue", "type": "string", "required": false, "description": "泳道标签内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "gray" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "EnableTime", "type": "string", "required": false, "description": "启用时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "Priority", "type": "integer", "required": false, "description": "泳道规则优先级 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Revision", "type": "string", "required": false, "description": "规则摘要 注意：此字段可能返回 null，表示取不到有效值。", "example": "df5bc49fd0084bf3a362b5152d52ad8a" } ] } ] } ], "required": [ "InstanceId", "LaneGroups" ] }, { "name": "DeleteGovernanceNamespaces", "description": "删除治理中心命名空间", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse 实例 id。", "example": "ins-df344df5" }, { "name": "GovernanceNamespaces", "type": "array", "required": true, "description": "命名空间信息。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "命名空间名。", "example": "Development" }, { "name": "Comment", "type": "string", "required": false, "description": "描述信息。", "example": "开发环境" }, { "name": "UserIds", "type": "array", "required": false, "description": "新增的可以操作此命名空间的用户ID列表", "example": "[1,2,3,4]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "新增的可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveUserIds", "type": "array", "required": false, "description": "移除可以操作此命名空间的用户ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveGroupIds", "type": "array", "required": false, "description": "移除可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "ServiceExportTo", "type": "array", "required": false, "description": "该命名空间下的服务对哪些命名空间下可见， 1、为空或者不填写，表示仅当前命名空间可见 2、列表内容仅一个元素，且为字符 *，表示所有命名空间可见（包括新增） 3、列表内容为部份命名空间名称，则只对这些命名空间下可见", "example": "[Namespace-1, Namespace-2]", "item_type": "string" }, { "name": "SyncToGlobalRegistry", "type": "boolean", "required": false, "description": "是否开启同步到全局注册中心", "example": "false" } ] } ], "required": [ "InstanceId", "GovernanceNamespaces" ] }, { "name": "DeleteGovernanceServices", "description": "删除治理中心服务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "GovernanceServices", "type": "array", "required": true, "description": "服务信息。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": true, "description": "服务所属命名空间。", "example": "Development" }, { "name": "Comment", "type": "string", "required": false, "description": "服务描述信息。", "example": "生产者服务。" }, { "name": "Metadatas", "type": "array", "required": false, "description": "服务元数据。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] }, { "name": "Department", "type": "string", "required": false, "description": "服务所属部门。", "example": "市场部" }, { "name": "Business", "type": "string", "required": false, "description": "服务所属业务。", "example": "采购业务" }, { "name": "UserIds", "type": "array", "required": false, "description": "被添加进来可以操作此命名空间的用户ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "被添加进来可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveUserIds", "type": "array", "required": false, "description": "从操作此命名空间的用户组ID列表被移除的ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveGroupIds", "type": "array", "required": false, "description": "从可以操作此命名空间的用户组ID列表中被移除的ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "ExportTo", "type": "array", "required": false, "description": "该服务对哪些命名空间可见", "example": "[Namespace-1,Namespace-2]", "item_type": "string" }, { "name": "SyncToGlobalRegistry", "type": "boolean", "required": false, "description": "是否开启同步到全局注册中心", "example": "false" } ] } ], "required": [ "InstanceId", "GovernanceServices" ] }, { "name": "DeleteNativeGatewayServerGroup", "description": "删除网关实例分组", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例id。 只支持后付费实例", "example": "gateway-xxxx1234" }, { "name": "GroupId", "type": "string", "required": true, "description": "网关分组id", "example": "group-xxx2345s" } ], "required": [ "GatewayId", "GroupId" ] }, { "name": "DeleteNativeGatewayServiceSource", "description": "删除网关服务来源实例", "status": "online", "parameters": [ { "name": "GatewayID", "type": "string", "required": true, "description": "网关实例 ID", "example": "gateway-dde03567" }, { "name": "SourceID", "type": "string", "required": true, "description": "服务来源实例 ID", "example": "ins-5ef8277d" } ], "required": [ "GatewayID", "SourceID" ] }, { "name": "DeleteWafDomains", "description": "删除 WAF 防护域名", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Domains", "type": "array", "required": true, "description": "WAF 防护域名列表", "example": "[\"tencent.com\"]", "item_type": "string" } ], "required": [ "GatewayId", "Domains" ] }, { "name": "DescribeAllConfigFileTemplates", "description": "获取全量配置文件模板列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE实例id", "example": "ins-df344df5\t" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAutoScalerResourceStrategies", "description": "查看弹性伸缩策略列表", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-4a34cf5f" }, { "name": "StrategyId", "type": "string", "required": false, "description": "策略ID", "example": "strategy-7bb4fcb0" } ], "required": [ "GatewayId" ] }, { "name": "DescribeAutoScalerResourceStrategyBindingGroups", "description": "查看弹性伸缩策略绑定的网关分组", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-4a34cf5f" }, { "name": "StrategyId", "type": "string", "required": true, "description": "策略ID", "example": "strategy-7bb4fcb0" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移量", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数量限制", "example": "10" } ], "required": [ "GatewayId", "StrategyId" ] }, { "name": "DescribeCloudNativeAPIGateway", "description": "获取云原生API网关实例信息", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID", "example": "gateway-xxxxxx" } ], "required": [ "GatewayId" ] }, { "name": "DescribeCloudNativeAPIGatewayCanaryRules", "description": "查询云原生网关灰度规则列表", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "ServiceId", "type": "string", "required": true, "description": "服务 ID", "example": "service-xxx" }, { "name": "RuleType", "type": "string", "required": false, "description": "灰度规则类别 Standard｜Lane", "example": "Standard" }, { "name": "Limit", "type": "integer", "required": false, "description": "列表数量", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "列表offset", "example": "0" } ], "required": [ "GatewayId", "ServiceId" ] }, { "name": "DescribeCloudNativeAPIGatewayCertificateDetails", "description": "查询云原生网关单个证书详情", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Id", "type": "string", "required": true, "description": "证书Id", "example": "6190e57f-f5b2-4295-a8c0-34d4a6d0e6e5" } ], "required": [ "GatewayId", "Id" ] }, { "name": "DescribeCloudNativeAPIGatewayCertificates", "description": "查询云原生网关证书列表", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Limit", "type": "integer", "required": false, "description": "列表数量", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "列表offset", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，多个过滤条件之间是与的关系，支持BindDomain ，Name", "example": "[]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "过滤字段", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "user-stu" } ] } ], "required": [ "GatewayId" ] }, { "name": "DescribeCloudNativeAPIGatewayConfig", "description": "获取云原生API网关实例网络配置信息", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxxxx" }, { "name": "GroupId", "type": "string", "required": false, "description": "分组id，不填时为默认分组", "example": "group-xxxx1234" } ], "required": [ "GatewayId" ] }, { "name": "DescribeCloudNativeAPIGatewayIPRestriction", "description": "查询云原生网关访问控制", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-3d19195c" }, { "name": "SourceType", "type": "string", "required": true, "description": "访问控制插件绑定的资源类型：route|service", "example": "route" }, { "name": "SourceId", "type": "string", "required": true, "description": "路由或服务的id", "example": "31f3bf99-f289-4b6e-8edc-5e09d9d8ce4f" } ], "required": [ "GatewayId", "SourceType", "SourceId" ] }, { "name": "DescribeCloudNativeAPIGatewayInfoByIp", "description": "根据公网IP查询云原生网关实例信息", "status": "online", "parameters": [ { "name": "PublicNetworkIP", "type": "string", "required": true, "description": "云原生网关的公网ip", "example": "1.1.1.1" } ], "required": [ "PublicNetworkIP" ] }, { "name": "DescribeCloudNativeAPIGatewayNodes", "description": "获取云原生网关节点列表", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxxxx" }, { "name": "GroupId", "type": "string", "required": false, "description": "实例分组id", "example": "group-xxx2345s" }, { "name": "Limit", "type": "integer", "required": false, "description": "翻页获取多少个", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页从第几个开始获取", "example": "0" } ], "required": [ "GatewayId" ] }, { "name": "DescribeCloudNativeAPIGatewayPorts", "description": "获取云原生API网关实例端口信息", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID", "example": "gateway-xxxxxx" } ], "required": [ "GatewayId" ] }, { "name": "DescribeCloudNativeAPIGatewayRouteRateLimit", "description": "查询云原生网关的限流插件(路由)", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关Id", "example": "gateway-962b7d7c" }, { "name": "Id", "type": "string", "required": true, "description": "路由Id，或路由名称。 不支持“未命名”", "example": "6f423439-ec27-4a2e-aff9-9e73ffa3da4" } ], "required": [ "GatewayId", "Id" ] }, { "name": "DescribeCloudNativeAPIGatewayRoutes", "description": "查询云原生网关路由列表", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Limit", "type": "integer", "required": false, "description": "翻页单页查询限制数量[0,1000], 默认值0", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页单页偏移量，默认值0", "example": "0" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务的名字，精确匹配", "example": "test-service" }, { "name": "RouteName", "type": "string", "required": false, "description": "路由的名字，精确匹配", "example": "test-route" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，多个过滤条件之间是与的关系，支持 name, path, host, method, service, protocol", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "过滤字段", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "user-stu" } ] } ], "required": [ "GatewayId" ] }, { "name": "DescribeCloudNativeAPIGatewayServiceRateLimit", "description": "查询云原生网关的限流插件(服务)", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关Id", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "服务名称，或服务ID。", "example": "service-demo" } ], "required": [ "GatewayId", "Name" ] }, { "name": "DescribeCloudNativeAPIGatewayServices", "description": "查询云原生网关服务列表", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Limit", "type": "integer", "required": false, "description": "列表数量", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "列表 offset", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，多个过滤条件之间是与的关系，支持 name,upstreamType", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "过滤字段", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "user-stu" } ] } ], "required": [ "GatewayId" ] }, { "name": "DescribeCloudNativeAPIGatewayServicesLight", "description": "轻量查询云原生网关服务列表", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Limit", "type": "integer", "required": false, "description": "列表数量", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "列表 offset", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，多个过滤条件之间是与的关系，支持 id、name、upstreamType", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "过滤字段", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "user-stu" } ] } ], "required": [ "GatewayId" ] }, { "name": "DescribeCloudNativeAPIGatewayUpstream", "description": "获取云原生网关服务详情下的Upstream列表", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "ServiceName", "type": "string", "required": true, "description": "服务名字", "example": "service-demo" } ], "required": [ "GatewayId", "ServiceName" ] }, { "name": "DescribeCloudNativeAPIGateways", "description": "获取云原生API网关实例列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "请求过滤参数，支持按照实例名称、ID和标签键值（Name、GatewayId、Tag）筛选", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤参数名", "example": "filter-name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤参数值", "example": "[\"a\",\"b\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeConfigFile", "description": "根据命名空间、组、名字查找配置文件", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE实例id", "example": "ins-02fa5c12" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespace" }, { "name": "Group", "type": "string", "required": false, "description": "组", "example": "group" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件名称", "example": "name" }, { "name": "Id", "type": "string", "required": false, "description": "配置文件Id", "example": "file-id" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConfigFileGroups", "description": "根据条件分页查询配置文件组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id", "example": "ins-df344df5\t" }, { "name": "Namespace", "type": "string", "required": false, "description": "根据命名空间过滤", "example": "namespace" }, { "name": "Group", "type": "string", "required": false, "description": "根据配置文件组名过滤", "example": "group" }, { "name": "FileName", "type": "string", "required": false, "description": "根据配置文件组名过滤", "example": "filename" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "5" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConfigFileRelease", "description": "获取配置文件发布", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE实例id", "example": "ins-df344df5\t" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间名称", "example": "namespace" }, { "name": "Group", "type": "string", "required": false, "description": "配置分组名称", "example": "group" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件名称", "example": "a.yaml" }, { "name": "ReleaseName", "type": "string", "required": false, "description": "配置文件发布名称", "example": "a.yaml" }, { "name": "Id", "type": "string", "required": false, "description": "配置文件发布Id", "example": "release-id" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConfigFileReleaseHistories", "description": "获取配置文件发布历史列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE实例id", "example": "ins-df344df5\t" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespace" }, { "name": "Group", "type": "string", "required": false, "description": "组", "example": "group" }, { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "a.yaml" }, { "name": "EndId", "type": "integer", "required": false, "description": "发布历史记录id，用于分页优化，一般指定 EndId，就不用指定 Offset，否则分页可能不连续", "example": "end-id" }, { "name": "ConfigFileId", "type": "string", "required": false, "description": "配置文件ID", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "50" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConfigFileReleaseVersions", "description": "查询某个配置所有版本信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "ins-0e02e26d" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespace" }, { "name": "Group", "type": "string", "required": false, "description": "配置分组", "example": "group" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名称", "example": "a.yaml" }, { "name": "ConfigFileId", "type": "string", "required": false, "description": "配置文件ID", "example": "file-id" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConfigFileReleases", "description": "查询配置版本列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "ins-0e02e26d" }, { "name": "Limit", "type": "integer", "required": true, "description": "条数", "example": "20" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespace" }, { "name": "Group", "type": "string", "required": false, "description": "配置分组", "example": "group" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名称", "example": "a.yaml" }, { "name": "OnlyUse", "type": "boolean", "required": false, "description": "只保护处于使用状态", "example": "true" }, { "name": "ReleaseName", "type": "string", "required": false, "description": "发布名称", "example": "release-name" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段，mtime/version/name ，默认version", "example": "version" }, { "name": "OrderDesc", "type": "string", "required": false, "description": "排序，asc/desc，默认 desc", "example": "desc" }, { "name": "Id", "type": "string", "required": false, "description": "配置发布ID", "example": "id" } ], "required": [ "InstanceId", "Limit", "Offset" ] }, { "name": "DescribeConfigFiles", "description": "根据命名空间、组名、名称、标签查询配置文件列表", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "namespace" }, { "name": "InstanceId", "type": "string", "required": false, "description": "TSE实例id", "example": "ins-d734da06" }, { "name": "Group", "type": "string", "required": false, "description": "组名", "example": "group" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件名称", "example": "name" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key-value 键", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "key-value 值", "example": "tom" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Id", "type": "string", "required": false, "description": "配置文件ID", "example": "file-id" } ], "required": [ "Namespace" ] }, { "name": "DescribeConfigFilesByGroup", "description": "根据group查询配置文件列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE实例id", "example": "ins-df344df5\t" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名", "example": "namespace" }, { "name": "Group", "type": "string", "required": true, "description": "组名", "example": "group" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" } ], "required": [ "InstanceId", "Namespace", "Group" ] }, { "name": "DescribeGovernanceAliases", "description": "查询治理中心服务别名列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "Service", "type": "string", "required": false, "description": "服务别名所指向的服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": false, "description": "服务别名所指向的命名空间名。", "example": "Development" }, { "name": "Alias", "type": "string", "required": false, "description": "服务别名。", "example": "192.168.1.1,10.10.10.1" }, { "name": "AliasNamespace", "type": "string", "required": false, "description": "服务别名命名空间。", "example": "v1" }, { "name": "Comment", "type": "string", "required": false, "description": "服务别名描述。", "example": "grpc" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "DescribeGovernanceInstances", "description": "查询服务实例", "status": "online", "parameters": [ { "name": "Service", "type": "string", "required": true, "description": "实例所在的服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": true, "description": "实例所在命名空间名。", "example": "Development" }, { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "Host", "type": "string", "required": false, "description": "根据实例ip过滤，多个ip使用英文逗号分隔。", "example": "192.168.1.1,10.10.10.1" }, { "name": "InstanceVersion", "type": "string", "required": false, "description": "根据实例版本过滤。", "example": "v1" }, { "name": "Protocol", "type": "string", "required": false, "description": "根据实例协议过滤。", "example": "grpc" }, { "name": "HealthStatus", "type": "boolean", "required": false, "description": "根据实例健康状态过滤。false：表示不健康，true：表示健康。", "example": "true" }, { "name": "Isolate", "type": "boolean", "required": false, "description": "根据实例隔离状态过滤。false：表示非隔离，true：表示隔离中。", "example": "1" }, { "name": "Metadatas", "type": "array", "required": false, "description": "根据元数据信息过滤。目前只支持一组元数据键值，若传了多个键值对，只会以第一个过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "Location", "type": "object", "required": false, "description": "地域", "example": "无", "children": [ { "name": "Region", "type": "string", "required": false, "description": "大区", "example": "huanan" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区", "example": "guangzhou" }, { "name": "Campus", "type": "string", "required": false, "description": "机房", "example": "guangzhou-1" } ] } ], "required": [ "Service", "Namespace", "InstanceId" ] }, { "name": "DescribeGovernanceLaneGroups", "description": "查询泳道组列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "引擎实例ID", "example": "ins-1231345" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页条数", "example": "10" }, { "name": "Name", "type": "string", "required": false, "description": "泳道名称", "example": "123123" }, { "name": "GroupID", "type": "string", "required": false, "description": "泳道ID", "example": "123123" }, { "name": "Brief", "type": "boolean", "required": false, "description": "是否展示泳道规则列表", "example": "true" } ], "required": [ "InstanceId", "Offset", "Limit" ] }, { "name": "DescribeGovernanceNamespaces", "description": "查询服务治理中心命名空间列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id", "example": "ins-df344df5" }, { "name": "Name", "type": "string", "required": false, "description": "根据命名空间名称过滤。", "example": "Development" }, { "name": "SyncToGlobalRegistry", "type": "string", "required": false, "description": "是否开启同步到全局注册中心", "example": "false" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "DescribeGovernanceServiceContractVersions", "description": "查询服务下契约版本列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "引擎实例ID", "example": "ins-123456" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "namespace" }, { "name": "Service", "type": "string", "required": false, "description": "服务名", "example": "service-name" } ], "required": [ "InstanceId", "Namespace" ] }, { "name": "DescribeGovernanceServiceContracts", "description": "查询服务契约定义列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "北极星引擎实例ID", "example": "ins-123456" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页条数", "example": "100" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespace" }, { "name": "Service", "type": "string", "required": false, "description": "服务名", "example": "service" }, { "name": "Name", "type": "string", "required": false, "description": "契约名称", "example": "name" }, { "name": "ContractVersion", "type": "string", "required": false, "description": "契约版本", "example": "v1.0.0" }, { "name": "Protocol", "type": "string", "required": false, "description": "契约协议", "example": "http" }, { "name": "Brief", "type": "boolean", "required": false, "description": "是否只展示基本信息", "example": "true" } ], "required": [ "InstanceId" ] }, { "name": "DescribeGovernanceServices", "description": "查询治理中心服务列表", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "按照服务名过滤，精确匹配。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": false, "description": "按照命名空间过滤，精确匹配。", "example": "Development" }, { "name": "Metadatas", "type": "array", "required": false, "description": "使用元数据过滤，目前只支持一组元组数，若传了多条，只会使用第一条元数据过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "InstanceId", "type": "string", "required": false, "description": "tse 实例 id。", "example": "ins-df344df5" }, { "name": "Department", "type": "string", "required": false, "description": "服务所属部门。", "example": "市场部" }, { "name": "Business", "type": "string", "required": false, "description": "服务所属业务。", "example": "采购业务" }, { "name": "Host", "type": "string", "required": false, "description": "服务中实例的ip，用来过滤服务。", "example": "10.10.6.2" }, { "name": "OnlyExistHealthyInstance", "type": "boolean", "required": false, "description": "是否只查询存在健康实例的服务", "example": "true" }, { "name": "SyncToGlobalRegistry", "type": "string", "required": false, "description": "是否开启同步到全局注册中心", "example": "false" }, { "name": "StatusFilter", "type": "array", "required": false, "description": "过滤筛选条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤参数名", "example": "filter-name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤参数值", "example": "[\"a\",\"b\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeInstanceTagInfos", "description": "查看实例的标签信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "ins-xxxxxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeNacosReplicas", "description": "查询Nacos类型引擎实例副本信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "引擎实例ID", "example": "ins-12345678" }, { "name": "Limit", "type": "integer", "required": false, "description": "副本列表Limit", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "副本列表Offset", "example": "1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeNacosServerInterfaces", "description": "查询nacos服务接口列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例id", "example": "ins-df344df5" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回的列表个数", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回的列表起始偏移量", "example": "1" } ], "required": [] }, { "name": "DescribeNativeGatewayServerGroups", "description": "查询云原生网关分组信息", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-test1234" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数，支持按照分组名称、分组ID（Name、GroupId）筛选", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤参数名", "example": "filter-name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤参数值", "example": "[\"a\",\"b\"]", "item_type": "string" } ] } ], "required": [ "GatewayId" ] }, { "name": "DescribeNativeGatewayServiceSources", "description": "查询网关服务来源实例列表", "status": "online", "parameters": [ { "name": "GatewayID", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-dde03567" }, { "name": "Limit", "type": "integer", "required": true, "description": "单页条数，最大100", "example": "100" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量", "example": "1" }, { "name": "SourceID", "type": "string", "required": false, "description": "服务来源ID", "example": "cls-qwertyuw" }, { "name": "SourceName", "type": "string", "required": false, "description": "服务来源实例名称，模糊搜索", "example": "nacos-learn-prod" }, { "name": "SourceTypes", "type": "array", "required": false, "description": "微服务引擎类型：TSE-Nacos｜TSE-Consul｜TSE-PolarisMesh｜Customer-Nacos｜Customer-Consul｜Customer-PolarisMesh", "example": "TSE-Nacos", "item_type": "string" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段类型，当前仅支持SourceName", "example": "SourceName" }, { "name": "OrderType", "type": "string", "required": false, "description": "排序类型，AES/DESC", "example": "AES" } ], "required": [ "GatewayID", "Limit", "Offset" ] }, { "name": "DescribeOneCloudNativeAPIGatewayService", "description": "获取云原生网关服务详情", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "服务名字，或服务ID", "example": "service-demo" } ], "required": [ "GatewayId", "Name" ] }, { "name": "DescribePublicAddressConfig", "description": "查询公网地址信息", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例id", "example": "gateway-xxxx1234" }, { "name": "GroupId", "type": "string", "required": false, "description": "查询该分组的公网信息，不传则查询实例所有的公网负载均衡信息", "example": "group-xxxx1234" } ], "required": [ "GatewayId" ] }, { "name": "DescribePublicNetwork", "description": "查询云原生API网关实例公网详情", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxxxx" }, { "name": "GroupId", "type": "string", "required": true, "description": "网关分组ID", "example": "group-xxxx1234" }, { "name": "NetworkId", "type": "string", "required": true, "description": "网络ID", "example": "network-xxxxxxxx" } ], "required": [ "GatewayId", "GroupId", "NetworkId" ] }, { "name": "DescribeSREInstanceAccessAddress", "description": "查询引擎实例访问地址", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "注册引擎实例Id", "example": "sre-12345678" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC ID", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID", "example": "subnet-xxxxx" }, { "name": "Workload", "type": "string", "required": false, "description": "引擎其他组件名称（pushgateway、polaris-limiter）", "example": "pushgateway" }, { "name": "EngineRegion", "type": "string", "required": false, "description": "部署地域", "example": "ap-beijing" } ], "required": [] }, { "name": "DescribeSREInstances", "description": "用于查询引擎实例列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "请求过滤参数", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤参数名", "example": "filter-name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤参数值", "example": "[\"a\",\"b\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "翻页单页查询限制数量[0,1000], 默认值0", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页单页偏移量，默认值0", "example": "0" }, { "name": "QueryType", "type": "string", "required": false, "description": "查询类型", "example": "config" }, { "name": "QuerySource", "type": "string", "required": false, "description": "调用方来源", "example": "tse" } ], "required": [] }, { "name": "DescribeUpstreamHealthCheckConfig", "description": "获取云原生网关服务健康检查配置", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-dde03767" }, { "name": "Name", "type": "string", "required": true, "description": "网关服务名称", "example": "service1" } ], "required": [ "GatewayId", "Name" ] }, { "name": "DescribeWafDomains", "description": "获取 WAF 防护域名", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" } ], "required": [ "GatewayId" ] }, { "name": "DescribeWafProtection", "description": "获取 WAF 防护状态", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "TypeList", "type": "array", "required": false, "description": "防护资源类型列表，支持查询多个类型（Global、Service、Route、Object）。为空时，默认查询Global类型。", "example": "[\"Global\",\"Object\"]", "item_type": "string" } ], "required": [ "GatewayId" ] }, { "name": "DescribeZookeeperReplicas", "description": "查询Zookeeper类型注册引擎实例副本信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "注册引擎实例ID", "example": "ers-12345678" }, { "name": "Limit", "type": "integer", "required": false, "description": "副本列表Limit", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "副本列表Offset", "example": "1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeZookeeperServerInterfaces", "description": "查询zookeeper服务接口列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例id", "example": "ins-df344df5" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回的列表个数", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回的列表起始偏移量", "example": "1" } ], "required": [] }, { "name": "ModifyAutoScalerResourceStrategy", "description": "更新弹性伸缩策略", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-4a34cf5f" }, { "name": "StrategyId", "type": "string", "required": true, "description": "策略ID", "example": "strategy-7bb4fcb0" }, { "name": "StrategyName", "type": "string", "required": false, "description": "策略名称", "example": "strategy-test" }, { "name": "Description", "type": "string", "required": false, "description": "策略描述", "example": "desc" }, { "name": "Config", "type": "object", "required": false, "description": "指标伸缩配置", "example": "无", "children": [ { "name": "MaxReplicas", "type": "integer", "required": false, "description": "最大副本数", "example": "5" }, { "name": "Metrics", "type": "array", "required": false, "description": "指标列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "指标类型 - Resource", "example": "Resource" }, { "name": "ResourceName", "type": "string", "required": false, "description": "指标资源名称 - cpu - memory", "example": "cpu" }, { "name": "TargetType", "type": "string", "required": false, "description": "指标目标类型，目前只支持百分比Utilization", "example": "Utilization" }, { "name": "TargetValue", "type": "integer", "required": false, "description": "指标目标值", "example": "80" } ] }, { "name": "Behavior", "type": "object", "required": false, "description": "指标伸缩行为配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ScaleUp", "type": "object", "required": false, "description": "扩容行为配置", "example": "无", "children": [ { "name": "StabilizationWindowSeconds", "type": "integer", "required": false, "description": "稳定窗口时间，扩容时默认0，缩容时默认300", "example": "300" }, { "name": "SelectPolicy", "type": "string", "required": false, "description": "选择策略依据", "example": "Max" }, { "name": "Policies", "type": "array", "required": false, "description": "扩缩容策略", "example": "无", "item_type": "string" } ] }, { "name": "ScaleDown", "type": "object", "required": false, "description": "缩容行为配置", "example": "无", "children": [ { "name": "StabilizationWindowSeconds", "type": "integer", "required": false, "description": "稳定窗口时间，扩容时默认0，缩容时默认300", "example": "300" }, { "name": "SelectPolicy", "type": "string", "required": false, "description": "选择策略依据", "example": "Max" }, { "name": "Policies", "type": "array", "required": false, "description": "扩缩容策略", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "CronConfig", "type": "object", "required": false, "description": "指标伸缩配置", "example": "无", "children": [ { "name": "Params", "type": "array", "required": false, "description": "定时伸缩配置参数列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Period", "type": "string", "required": false, "description": "定时伸缩周期", "example": "1 * *" }, { "name": "StartAt", "type": "string", "required": false, "description": "定时伸缩开始时间", "example": "17:00" }, { "name": "TargetReplicas", "type": "integer", "required": false, "description": "定时伸缩目标节点数，不超过指标伸缩中定义的最大节点数", "example": "50" }, { "name": "Crontab", "type": "string", "required": false, "description": "定时伸缩cron表达式，无需输入", "example": "0 00 00 * * *" } ] } ] } ], "required": [ "GatewayId", "StrategyId" ] }, { "name": "ModifyCloudNativeAPIGateway", "description": "修改云原生API网关实例基础信息", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxxxx" }, { "name": "Name", "type": "string", "required": false, "description": "云原生API网关名字, 最多支持60个字符。", "example": "kong-test" }, { "name": "Description", "type": "string", "required": false, "description": "云原生API网关描述信息, 最多支持120个字符。", "example": "kong test" }, { "name": "EnableCls", "type": "boolean", "required": false, "description": "是否开启 CLS 日志。暂时取值只能是 true，即只能从关闭状态变成开启状态。", "example": "true" }, { "name": "InternetPayMode", "type": "string", "required": false, "description": "公网计费模式。可选取值 BANDWIDTH | TRAFFIC ，表示按带宽和按流量计费。", "example": "TRAFFIC" }, { "name": "DeleteProtect", "type": "boolean", "required": false, "description": "是否开启实例删除保护,默认false", "example": "false" } ], "required": [ "GatewayId" ] }, { "name": "ModifyCloudNativeAPIGatewayCanaryRule", "description": "修改云原生网关的灰度规则", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID", "example": "gateway-962b7d7c" }, { "name": "ServiceId", "type": "string", "required": true, "description": "服务 ID", "example": "service-xxx" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，同一个服务的灰度规则优先级是唯一的", "example": "10" }, { "name": "CanaryRule", "type": "object", "required": false, "description": "灰度规则配置", "example": "无", "children": [ { "name": "Priority", "type": "integer", "required": true, "description": "优先级，值范围为 0 到 100；值越大，优先级越高；不同规则间优先级不可重复", "example": "100" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "是否启用规则", "example": "true" }, { "name": "ConditionList", "type": "array", "required": false, "description": "参数匹配条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "条件类型，支持 path, method, query, header, cookie, body 和 system。", "example": "header" }, { "name": "Key", "type": "string", "required": false, "description": "参数名", "example": "x-user-id" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符，支持 \"le\", \"eq\", \"lt\", \"ne\", \"ge\", \"gt\", \"regex\", \"exists\", \"in\", \"not in\", \"prefix\" ,\"exact\", \"regex\" 等", "example": "==" }, { "name": "Value", "type": "string", "required": false, "description": "目标参数值", "example": "user-stu" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符，当 Operator 为 in 或者 not in 时生效。支持值为英文逗号，英文分号，空格，换行符。", "example": "," }, { "name": "GlobalConfigId", "type": "string", "required": false, "description": "全局配置 Id", "example": "4fe634e9-ea28-4f1e-8461-da89f3b84d28" }, { "name": "GlobalConfigName", "type": "string", "required": false, "description": "全局配置名称", "example": "global-conf-stu" } ] }, { "name": "BalancedServiceList", "type": "array", "required": false, "description": "服务的流量百分比配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ServiceID", "type": "string", "required": false, "description": "服务 ID，作为入参时，必填", "example": "2a212560-220a-46f6-b139-3238eb8ea041" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称，作为入参时，无意义", "example": "learn" }, { "name": "UpstreamName", "type": "string", "required": false, "description": "Upstream 名称，作为入参时，无意义", "example": "learn" }, { "name": "Percent", "type": "float", "required": false, "description": "百分比，10 即 10%，范围0-100", "example": "10" } ] }, { "name": "ServiceId", "type": "string", "required": false, "description": "归属服务 ID", "example": "2a212560-220a-46f6-b139-3238eb8ea041" }, { "name": "ServiceName", "type": "string", "required": false, "description": "归属服务名称", "example": "learn-svc" }, { "name": "RuleType", "type": "string", "required": false, "description": "灰度规则类别 Standard｜Lane", "example": "Standard" }, { "name": "MatchType", "type": "string", "required": false, "description": "全链路灰度策略多个条件之间的匹配方式，与AND，或OR", "example": "AND" }, { "name": "GroupId", "type": "string", "required": false, "description": "泳道组ID", "example": "group-4se0czf7" }, { "name": "GroupName", "type": "string", "required": false, "description": "泳道组名称", "example": "公网入口分组" }, { "name": "LaneId", "type": "string", "required": false, "description": "泳道ID", "example": "4e00e834cc984314a9a33fa4bb08bc5a" }, { "name": "LaneName", "type": "string", "required": false, "description": "泳道名称", "example": "在线学习服务泳道" }, { "name": "MatchMode", "type": "string", "required": false, "description": "泳道匹配规则：严格STRICT｜宽松PERMISSIVE", "example": "STRICT" }, { "name": "LaneTag", "type": "string", "required": false, "description": "泳道标签", "example": "lane:v1" } ] }, { "name": "CanaryRuleList", "type": "array", "required": false, "description": "灰度规则配置列表，如果配置了此参数，将以此参数为准，忽略Priority和CanaryRule参数", "example": "无", "item_type": "object", "children": [ { "name": "Priority", "type": "integer", "required": false, "description": "优先级", "example": "10" }, { "name": "CanaryRule", "type": "object", "required": false, "description": "灰度规则配置", "example": "无", "children": [ { "name": "Priority", "type": "integer", "required": true, "description": "优先级，值范围为 0 到 100；值越大，优先级越高；不同规则间优先级不可重复", "example": "100" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "是否启用规则", "example": "true" }, { "name": "ConditionList", "type": "array", "required": false, "description": "参数匹配条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "条件类型，支持 path, method, query, header, cookie, body 和 system。", "example": "header" }, { "name": "Key", "type": "string", "required": false, "description": "参数名", "example": "x-user-id" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符，支持 \"le\", \"eq\", \"lt\", \"ne\", \"ge\", \"gt\", \"regex\", \"exists\", \"in\", \"not in\", \"prefix\" ,\"exact\", \"regex\" 等", "example": "==" }, { "name": "Value", "type": "string", "required": false, "description": "目标参数值", "example": "user-stu" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符，当 Operator 为 in 或者 not in 时生效。支持值为英文逗号，英文分号，空格，换行符。", "example": "," }, { "name": "GlobalConfigId", "type": "string", "required": false, "description": "全局配置 Id", "example": "4fe634e9-ea28-4f1e-8461-da89f3b84d28" }, { "name": "GlobalConfigName", "type": "string", "required": false, "description": "全局配置名称", "example": "global-conf-stu" } ] }, { "name": "BalancedServiceList", "type": "array", "required": false, "description": "服务的流量百分比配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ServiceID", "type": "string", "required": false, "description": "服务 ID，作为入参时，必填", "example": "2a212560-220a-46f6-b139-3238eb8ea041" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称，作为入参时，无意义", "example": "learn" }, { "name": "UpstreamName", "type": "string", "required": false, "description": "Upstream 名称，作为入参时，无意义", "example": "learn" }, { "name": "Percent", "type": "float", "required": false, "description": "百分比，10 即 10%，范围0-100", "example": "10" } ] }, { "name": "ServiceId", "type": "string", "required": false, "description": "归属服务 ID", "example": "2a212560-220a-46f6-b139-3238eb8ea041" }, { "name": "ServiceName", "type": "string", "required": false, "description": "归属服务名称", "example": "learn-svc" }, { "name": "RuleType", "type": "string", "required": false, "description": "灰度规则类别 Standard｜Lane", "example": "Standard" }, { "name": "MatchType", "type": "string", "required": false, "description": "全链路灰度策略多个条件之间的匹配方式，与AND，或OR", "example": "AND" }, { "name": "GroupId", "type": "string", "required": false, "description": "泳道组ID", "example": "group-4se0czf7" }, { "name": "GroupName", "type": "string", "required": false, "description": "泳道组名称", "example": "公网入口分组" }, { "name": "LaneId", "type": "string", "required": false, "description": "泳道ID", "example": "4e00e834cc984314a9a33fa4bb08bc5a" }, { "name": "LaneName", "type": "string", "required": false, "description": "泳道名称", "example": "在线学习服务泳道" }, { "name": "MatchMode", "type": "string", "required": false, "description": "泳道匹配规则：严格STRICT｜宽松PERMISSIVE", "example": "STRICT" }, { "name": "LaneTag", "type": "string", "required": false, "description": "泳道标签", "example": "lane:v1" } ] } ] } ], "required": [ "GatewayId", "ServiceId" ] }, { "name": "ModifyCloudNativeAPIGatewayCertificate", "description": "更新云原生网关证书", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Id", "type": "string", "required": true, "description": "证书id", "example": "f9a5d230-4fa6-4f45-86c3-c5f49d6ffc83" }, { "name": "Key", "type": "string", "required": false, "description": "证书私钥，CertSource为native时必填。", "example": "-----BEGIN PRIVATE KEY-----\\nMIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgokysviOMJk43IY6s\\nQpD6VUUAM8aU5RPyFTNUuJXN+JuhRANCAATJWrcGNiaU94X8JFEornursRSbx0VY\\nT2XqoJyK+g2TdRdDQw8t9su9IQD5FAYwR+Uh5TNeIqJNq0DWLOcovUQ+\\n-----END PRIVATE KEY-----" }, { "name": "Crt", "type": "string", "required": false, "description": "证书pem格式，CertSource为native时必填。", "example": "-----BEGIN CERTIFICATE-----\\nMIIBpTCCAUugAwIBAgIUVHl/MMu4SMSqDKEHmagHTg7kHO4wCQYHKoZIzj0EATAx\\nMRAwDgYDVQQDDAdhYmMuY29tMRAwDgYDVQQKDAdhYmMuY29tMQswCQYDVQQGEwJD\\nTjAeFw0yMjA4MTgwMjEwMDBaFw0yMjA4MzEwNTQ1MDBaMFYxCzAJBgNVBAYTAkNO\\nMRIwEAYDVQQIDAlndWFuZ2RvbmcxEzARBgNVBAcMCmd1YW5nemhvdSAxDDAKBgNV\\nBAoMA2FiYzEQMA4GA1UEAwwHYWJjLmNvbTBZMBMGByqGSM49AgEGCCqGSM49AwEH\\nA0IABMlatwY2JpT3hfwkUSiue6uxFJvHRVhPZeqgnIr6DZN1F0NDDy32y70hAPkU\\nBjBH5SHlM14iok2rQNYs5yi9RD6jHTAbMAsGA1UdEQQEMAKCADAMBgNVHRMBAf8E\\nAjAAMAkGByqGSM49BAEDSQAwRgIhAILkENW+azqYYHCdWCMLGjvc5ii3N/57so5o\\nz0T+lKkIAiEA4u+2vUZIjMffqLND3ecLx3lNj+CSo4EF31yBTEEkfMM=\\n-----END CERTIFICATE-----" }, { "name": "CertId", "type": "string", "required": false, "description": "ssl平台证书 Id，CertSource为ssl时必填。", "example": "8RTlvcjR" }, { "name": "CertSource", "type": "string", "required": false, "description": "证书来源 - ssl (ssl平台证书)，默认值 - native (kong自定义证书)", "example": "native" } ], "required": [ "GatewayId", "Id" ] }, { "name": "ModifyCloudNativeAPIGatewayRoute", "description": "修改云原生网关路由", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "ServiceID", "type": "string", "required": true, "description": "所属服务的ID", "example": "104dd157-5008-4d3c-9feb-4767667863ff" }, { "name": "RouteID", "type": "string", "required": true, "description": "路由的ID，实例级别唯一", "example": "916462a4-8ce4-4605-a7b7-66cd51c38201" }, { "name": "RouteName", "type": "string", "required": false, "description": "路由的名字，实例级别唯一，可以不提供", "example": "route-demo" }, { "name": "Methods", "type": "array", "required": false, "description": "路由的方法，其中方法可选值： - GET - POST - DELETE - PUT - OPTIONS - PATCH - HEAD - ANY - TRACE - COPY - MOVE - PROPFIND - PROPPATCH - MKCOL - LOCK - UNLOCK", "example": "[\"GET\"]", "item_type": "string" }, { "name": "Hosts", "type": "array", "required": false, "description": "路由的域名", "example": "[\"www.demo.com\"]", "item_type": "string" }, { "name": "Paths", "type": "array", "required": false, "description": "路由的路径", "example": "[\"/\"]", "item_type": "string" }, { "name": "Protocols", "type": "array", "required": false, "description": "路由的协议，可选 - https - http", "example": "[\"https\"]", "item_type": "string" }, { "name": "PreserveHost", "type": "boolean", "required": false, "description": "转发到后端时是否保留Host", "example": "true" }, { "name": "HttpsRedirectStatusCode", "type": "integer", "required": false, "description": "https重定向状态码", "example": "308" }, { "name": "StripPath", "type": "boolean", "required": false, "description": "转发到后端时是否StripPath", "example": "true" }, { "name": "DestinationPorts", "type": "array", "required": false, "description": "四层匹配的目的端口", "example": "8000", "item_type": "integer" }, { "name": "Headers", "type": "array", "required": false, "description": "路由的Headers", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key", "example": "key" }, { "name": "Value", "type": "string", "required": false, "description": "value", "example": "value" } ] }, { "name": "RequestBuffering", "type": "boolean", "required": false, "description": "是否缓存请求body，默认true", "example": "true" }, { "name": "ResponseBuffering", "type": "boolean", "required": false, "description": "是否缓存响应body，默认true", "example": "true" }, { "name": "RegexPriority", "type": "integer", "required": false, "description": "增加优先级", "example": "0" } ], "required": [ "GatewayId", "ServiceID", "RouteID" ] }, { "name": "ModifyCloudNativeAPIGatewayRouteRateLimit", "description": "修改云原生网关限流插件(路由)", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Id", "type": "string", "required": true, "description": "路由id，或路由名称。 不支持“未命名”", "example": "6f423439-ec27-4a2e-aff9-9e73ffa3da4" }, { "name": "LimitDetail", "type": "object", "required": true, "description": "限流配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "插件启用状态", "example": "true" }, { "name": "QpsThresholds", "type": "array", "required": false, "description": "qps阈值", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "Path", "type": "string", "required": false, "description": "需要进行流量控制的请求路径", "example": "/demo" }, { "name": "Header", "type": "string", "required": false, "description": "需要进行流量控制的请求头Key", "example": "Host" }, { "name": "LimitBy", "type": "string", "required": false, "description": "限流依据 ip service consumer credential path header", "example": "ip" }, { "name": "ExternalRedis", "type": "object", "required": false, "description": "外部redis配置", "example": "无", "children": [ { "name": "RedisHost", "type": "string", "required": true, "description": "redis ip", "example": "127.0.0.1" }, { "name": "RedisPassword", "type": "string", "required": true, "description": "redis密码", "example": "password" }, { "name": "RedisPort", "type": "integer", "required": true, "description": "redis端口", "example": "80" }, { "name": "RedisTimeout", "type": "integer", "required": true, "description": "超时时间 ms", "example": "10" } ] }, { "name": "GlobalConfigId", "type": "string", "required": false, "description": "全局配置中的redis配置", "example": "9a4e0f39-fa6a-44d8-8e3e-10f016ad78de" }, { "name": "Policy", "type": "string", "required": false, "description": "计数器策略 local 单机 redis 默认redis external_redis 外部redis", "example": "local" }, { "name": "RateLimitResponse", "type": "object", "required": false, "description": "响应配置，响应策略为text", "example": "无", "children": [ { "name": "Body", "type": "string", "required": false, "description": "自定义响应体", "example": "hello" }, { "name": "Headers", "type": "array", "required": false, "description": "Headers", "example": "[{key:\"\",value:\"\"},]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key", "example": "key" }, { "name": "Value", "type": "string", "required": false, "description": "value", "example": "value" } ] }, { "name": "HttpStatus", "type": "integer", "required": false, "description": "http状态码", "example": "200" } ] }, { "name": "RateLimitResponseUrl", "type": "string", "required": false, "description": "请求转发地址", "example": "http://127.0.0.1/downgrade" }, { "name": "ResponseType", "type": "string", "required": false, "description": "响应策略 url请求转发 text 响应配置 default 直接返回", "example": "url" }, { "name": "HideClientHeaders", "type": "boolean", "required": false, "description": "是否隐藏限流客户端响应头", "example": "true" }, { "name": "LineUpTime", "type": "integer", "required": false, "description": "排队时间", "example": "0" }, { "name": "IsDelay", "type": "boolean", "required": false, "description": "是否开启请求排队", "example": "true" }, { "name": "BasicLimitQpsThresholds", "type": "array", "required": false, "description": "基础限流 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "LimitRules", "type": "array", "required": false, "description": "参数限流的规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "请求匹配条件", "example": "{\"Key\":\"ip\",\"Values\":[\"8.8.8.8/24\"]}", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "限流条件的Key", "example": "ip" }, { "name": "Values", "type": "array", "required": false, "description": "限流条件的Values", "example": "8.8.8.8/24", "item_type": "string" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符", "example": "eq" }, { "name": "Name", "type": "string", "required": false, "description": "header或query对应的name", "example": "Auth" } ] }, { "name": "LimitBy", "type": "array", "required": false, "description": "参数限流依据组合", "example": "[{\"Key\":\"ip\",\"Value\":\"\"},{\"Key\":\"header\",\"Value\":\"host\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "条件的Key", "example": "header" }, { "name": "Value", "type": "string", "required": false, "description": "条件的Value", "example": "host" } ] }, { "name": "QpsThresholds", "type": "array", "required": false, "description": "限流阈值", "example": "[{\"Unit\":\"second\",\"Max\":10000}]", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "AccurateQpsThresholds", "type": "array", "required": false, "description": "精确限流阈值", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "GlobalConfigId", "type": "string", "required": true, "description": "全局配置ID", "example": "aa2090e1-0117-404f-b73f-69b662b6834f" } ] } ] } ] } ], "required": [ "GatewayId", "Id", "LimitDetail" ] }, { "name": "ModifyCloudNativeAPIGatewayService", "description": "修改云原生网关服务", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "服务名称", "example": "service-demo" }, { "name": "Protocol", "type": "string", "required": true, "description": "请求协议： - https - http - tcp - udp", "example": "http" }, { "name": "Timeout", "type": "integer", "required": true, "description": "超时时间，单位ms", "example": "5000" }, { "name": "Retries", "type": "integer", "required": true, "description": "重试次数", "example": "0" }, { "name": "UpstreamType", "type": "string", "required": true, "description": "服务类型: - Kubernetes - Registry - IPList - HostIP - Scf", "example": "HostIP" }, { "name": "UpstreamInfo", "type": "object", "required": true, "description": "服务配置", "example": "无", "children": [ { "name": "Host", "type": "string", "required": false, "description": "IP或域名", "example": "www.test.com" }, { "name": "Port", "type": "integer", "required": false, "description": "端口", "example": "80" }, { "name": "SourceID", "type": "string", "required": false, "description": "服务来源ID", "example": "ins-102555d0" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "Default" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务（注册中心或Kubernetes中的服务）名字", "example": "demo-service" }, { "name": "Targets", "type": "array", "required": false, "description": "服务后端类型是IPList时提供 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Host", "type": "string", "required": true, "description": "Host", "example": "8.8.8.8" }, { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "100" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重", "example": "10" }, { "name": "Health", "type": "string", "required": false, "description": "健康状态", "example": "HEALTHY" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间", "example": "2024-11-25 10:49:23" }, { "name": "Source", "type": "string", "required": false, "description": "Target的来源", "example": "AutoScaling" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例ID", "example": "ins-ze3124da" }, { "name": "CvmInstanceName", "type": "string", "required": false, "description": "CVM实例名称", "example": "在线学习服务" }, { "name": "Tags", "type": "array", "required": false, "description": "target标签", "example": "learn", "item_type": "string" } ] }, { "name": "SourceType", "type": "string", "required": false, "description": "服务来源类型", "example": "TKE" }, { "name": "ScfType", "type": "string", "required": false, "description": "SCF函数类型", "example": "event" }, { "name": "ScfNamespace", "type": "string", "required": false, "description": "SCF函数命名空间", "example": "Default" }, { "name": "ScfLambdaName", "type": "string", "required": false, "description": "SCF函数名", "example": "helloworld" }, { "name": "ScfLambdaQualifier", "type": "string", "required": false, "description": "SCF函数版本", "example": "$LATEST" }, { "name": "SlowStart", "type": "integer", "required": false, "description": "冷启动时间，单位秒", "example": "60" }, { "name": "Algorithm", "type": "string", "required": false, "description": "负载均衡算法，默认为 round-robin，还支持 least-connections，consisten_hashing", "example": "round-robin" }, { "name": "AutoScalingGroupID", "type": "string", "required": false, "description": "CVM弹性伸缩组ID", "example": "as-4se0czf7" }, { "name": "AutoScalingCvmPort", "type": "integer", "required": false, "description": "CVM弹性伸缩组端口", "example": "80" }, { "name": "AutoScalingTatCmdStatus", "type": "string", "required": false, "description": "CVM弹性伸缩组使用的CVM TAT命令状态", "example": "Normal" }, { "name": "AutoScalingHookStatus", "type": "string", "required": false, "description": "CVM弹性伸缩组生命周期挂钩状态", "example": "Normal" }, { "name": "SourceName", "type": "string", "required": false, "description": "服务来源的名字", "example": "tse-polaris" }, { "name": "RealSourceType", "type": "string", "required": false, "description": "精确的服务来源类型，新建服务来源时候传入的类型", "example": "TKE" }, { "name": "HealthStatus", "type": "string", "required": false, "description": "upstream健康状态HEALTHY（健康）, UNHEALTHY（异常）, HEALTHCHECKS_OFF（未开启）和NONE（不支持健康检查）", "example": "HEALTHY" }, { "name": "ScfCamAuthEnable", "type": "boolean", "required": false, "description": "云函数是否开启CAM鉴权，不填时默认为开启(true)", "example": "true" }, { "name": "ScfIsBase64Encoded", "type": "boolean", "required": false, "description": "云函数是否开启Base64编码，默认为false", "example": "false" }, { "name": "ScfIsIntegratedResponse", "type": "boolean", "required": false, "description": "云函数是否开启响应集成，默认为false", "example": "false" } ] }, { "name": "ID", "type": "string", "required": true, "description": "服务ID", "example": "916462a4-8ce4-4605-a7b7-66cd51c38201" }, { "name": "Path", "type": "string", "required": false, "description": "请求路径", "example": "/v1/users" } ], "required": [ "GatewayId", "Name", "Protocol", "Timeout", "Retries", "UpstreamType", "UpstreamInfo", "ID" ] }, { "name": "ModifyCloudNativeAPIGatewayServiceRateLimit", "description": "修改云原生网关限流插件(服务)", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Name", "type": "string", "required": true, "description": "服务名称，或服务ID", "example": "service-demo" }, { "name": "LimitDetail", "type": "object", "required": true, "description": "限流配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "插件启用状态", "example": "true" }, { "name": "QpsThresholds", "type": "array", "required": false, "description": "qps阈值", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "Path", "type": "string", "required": false, "description": "需要进行流量控制的请求路径", "example": "/demo" }, { "name": "Header", "type": "string", "required": false, "description": "需要进行流量控制的请求头Key", "example": "Host" }, { "name": "LimitBy", "type": "string", "required": false, "description": "限流依据 ip service consumer credential path header", "example": "ip" }, { "name": "ExternalRedis", "type": "object", "required": false, "description": "外部redis配置", "example": "无", "children": [ { "name": "RedisHost", "type": "string", "required": true, "description": "redis ip", "example": "127.0.0.1" }, { "name": "RedisPassword", "type": "string", "required": true, "description": "redis密码", "example": "password" }, { "name": "RedisPort", "type": "integer", "required": true, "description": "redis端口", "example": "80" }, { "name": "RedisTimeout", "type": "integer", "required": true, "description": "超时时间 ms", "example": "10" } ] }, { "name": "GlobalConfigId", "type": "string", "required": false, "description": "全局配置中的redis配置", "example": "9a4e0f39-fa6a-44d8-8e3e-10f016ad78de" }, { "name": "Policy", "type": "string", "required": false, "description": "计数器策略 local 单机 redis 默认redis external_redis 外部redis", "example": "local" }, { "name": "RateLimitResponse", "type": "object", "required": false, "description": "响应配置，响应策略为text", "example": "无", "children": [ { "name": "Body", "type": "string", "required": false, "description": "自定义响应体", "example": "hello" }, { "name": "Headers", "type": "array", "required": false, "description": "Headers", "example": "[{key:\"\",value:\"\"},]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key", "example": "key" }, { "name": "Value", "type": "string", "required": false, "description": "value", "example": "value" } ] }, { "name": "HttpStatus", "type": "integer", "required": false, "description": "http状态码", "example": "200" } ] }, { "name": "RateLimitResponseUrl", "type": "string", "required": false, "description": "请求转发地址", "example": "http://127.0.0.1/downgrade" }, { "name": "ResponseType", "type": "string", "required": false, "description": "响应策略 url请求转发 text 响应配置 default 直接返回", "example": "url" }, { "name": "HideClientHeaders", "type": "boolean", "required": false, "description": "是否隐藏限流客户端响应头", "example": "true" }, { "name": "LineUpTime", "type": "integer", "required": false, "description": "排队时间", "example": "0" }, { "name": "IsDelay", "type": "boolean", "required": false, "description": "是否开启请求排队", "example": "true" }, { "name": "BasicLimitQpsThresholds", "type": "array", "required": false, "description": "基础限流 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "LimitRules", "type": "array", "required": false, "description": "参数限流的规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "请求匹配条件", "example": "{\"Key\":\"ip\",\"Values\":[\"8.8.8.8/24\"]}", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "限流条件的Key", "example": "ip" }, { "name": "Values", "type": "array", "required": false, "description": "限流条件的Values", "example": "8.8.8.8/24", "item_type": "string" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符", "example": "eq" }, { "name": "Name", "type": "string", "required": false, "description": "header或query对应的name", "example": "Auth" } ] }, { "name": "LimitBy", "type": "array", "required": false, "description": "参数限流依据组合", "example": "[{\"Key\":\"ip\",\"Value\":\"\"},{\"Key\":\"header\",\"Value\":\"host\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "条件的Key", "example": "header" }, { "name": "Value", "type": "string", "required": false, "description": "条件的Value", "example": "host" } ] }, { "name": "QpsThresholds", "type": "array", "required": false, "description": "限流阈值", "example": "[{\"Unit\":\"second\",\"Max\":10000}]", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "Max", "type": "integer", "required": true, "description": "阈值", "example": "10" } ] }, { "name": "AccurateQpsThresholds", "type": "array", "required": false, "description": "精确限流阈值", "example": "无", "item_type": "object", "children": [ { "name": "Unit", "type": "string", "required": true, "description": "qps阈值控制维度,包含:second、minute、hour、day、month、year", "example": "second、minute、hour、day、month、year" }, { "name": "GlobalConfigId", "type": "string", "required": true, "description": "全局配置ID", "example": "aa2090e1-0117-404f-b73f-69b662b6834f" } ] } ] } ] } ], "required": [ "GatewayId", "Name", "LimitDetail" ] }, { "name": "ModifyConfigFileGroup", "description": "批量修改配置文件组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id", "example": "ins-df344df5\t" }, { "name": "ConfigFileGroup", "type": "object", "required": true, "description": "配置文件组", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "配置文件组id", "example": "100" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件组名称", "example": "janice-test" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "namespaceName" }, { "name": "Comment", "type": "string", "required": false, "description": "备注", "example": "Comment" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2023-03-07 00:00:00" }, { "name": "CreateBy", "type": "string", "required": false, "description": "创建者", "example": "usera" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间", "example": "2023-03-07 00:00:00" }, { "name": "ModifyBy", "type": "string", "required": false, "description": "修改者", "example": "userb" }, { "name": "FileCount", "type": "integer", "required": false, "description": "文件数", "example": "100" }, { "name": "UserIds", "type": "array", "required": false, "description": "关联用户，link_users", "example": "[\"usera\",\"userb\"]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "组id，link_groups", "example": "[\"group-1\"]", "item_type": "string" }, { "name": "RemoveUserIds", "type": "array", "required": false, "description": "remove_link_users", "example": "[\"usera\"]", "item_type": "string" }, { "name": "RemoveGroupIds", "type": "array", "required": false, "description": "remove_link_groups", "example": "[\"group-1\"]", "item_type": "string" }, { "name": "Editable", "type": "boolean", "required": false, "description": "是否可编辑", "example": "true" }, { "name": "Owner", "type": "string", "required": false, "description": "归属者", "example": "usera" }, { "name": "Department", "type": "string", "required": false, "description": "部门", "example": "DepartmentName" }, { "name": "Business", "type": "string", "required": false, "description": "业务", "example": "BusinessName" }, { "name": "ConfigFileGroupTags", "type": "array", "required": false, "description": "配置文件组标签", "example": "[\"taga\"]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key-value 键", "example": "Name" }, { "name": "Value", "type": "string", "required": false, "description": "key-value 值", "example": "Tom" } ] } ] } ], "required": [ "InstanceId", "ConfigFileGroup" ] }, { "name": "ModifyConfigFiles", "description": "修改配置文件", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ins-df344df5", "example": "ins-123456" }, { "name": "ConfigFile", "type": "object", "required": true, "description": "配置文件列表", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "配置文件id", "example": "configId" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件名称", "example": "application" }, { "name": "Namespace", "type": "string", "required": false, "description": "配置文件命名空间", "example": "namespaceName" }, { "name": "Group", "type": "string", "required": false, "description": "配置文件组", "example": "groupName" }, { "name": "Content", "type": "string", "required": false, "description": "配置文件内容", "example": "configContent" }, { "name": "Format", "type": "string", "required": false, "description": "配置文件格式", "example": "text" }, { "name": "Comment", "type": "string", "required": false, "description": "配置文件注释", "example": "Comment" }, { "name": "Status", "type": "string", "required": false, "description": "配置文件状态", "example": "status" }, { "name": "Tags", "type": "array", "required": false, "description": "配置文件标签数组", "example": "[\"taga\",\"tagb\"]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key-value 键", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "key-value 值", "example": "tom" } ] }, { "name": "CreateTime", "type": "string", "required": false, "description": "配置文件创建时间", "example": "2024-12-29 16:23:00" }, { "name": "CreateBy", "type": "string", "required": false, "description": "配置文件创建者", "example": "usera" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "配置文件修改时间", "example": "2024-12-29 16:23:00" }, { "name": "ModifyBy", "type": "string", "required": false, "description": "配置文件修改者", "example": "usera" }, { "name": "ReleaseTime", "type": "string", "required": false, "description": "配置文件发布时间", "example": "2024-12-29 16:23:00" }, { "name": "ReleaseBy", "type": "string", "required": false, "description": "配置文件发布者", "example": "usera" }, { "name": "ConfigFileSupportedClient", "type": "integer", "required": false, "description": "配置文件类型", "example": "client_sdk" }, { "name": "ConfigFilePersistent", "type": "object", "required": false, "description": "配置文件持久化", "example": "无", "children": [ { "name": "Encoding", "type": "string", "required": false, "description": "文件编码", "example": "UTF-8" }, { "name": "Path", "type": "string", "required": false, "description": "文件下发路径", "example": "/path/var" }, { "name": "PostCmd", "type": "string", "required": false, "description": "文件后置命令", "example": "echo aaa;\\n echo ccc" } ] }, { "name": "Encrypted", "type": "boolean", "required": false, "description": "是否开启加密算法", "example": "true" }, { "name": "EncryptAlgo", "type": "string", "required": false, "description": "加密算法", "example": "AES" } ] } ], "required": [ "InstanceId", "ConfigFile" ] }, { "name": "ModifyConsoleNetwork", "description": "修改网关实例Konga网络配置", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxxxx" }, { "name": "NetworkType", "type": "string", "required": true, "description": "网络类型： - Open 公网 - Internal 内网（暂不支持）", "example": "Open" }, { "name": "Operate", "type": "string", "required": false, "description": "开启Konga网络，不填时默认为Open - Open，开启 - Close，关闭", "example": "Open" }, { "name": "AccessControl", "type": "object", "required": false, "description": "访问控制策略", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": true, "description": "访问模式：Whitelist|Blacklist", "example": "Whitelist" }, { "name": "CidrWhiteList", "type": "array", "required": false, "description": "白名单列表", "example": "[\"0.0.0.0\"]", "item_type": "string" }, { "name": "CidrBlackList", "type": "array", "required": false, "description": "黑名单列表", "example": "[\"100.10.0.0/24\"]", "item_type": "string" } ] } ], "required": [ "GatewayId", "NetworkType" ] }, { "name": "ModifyGovernanceAlias", "description": "修改治理中心服务别名", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "Alias", "type": "string", "required": true, "description": "服务别名", "example": "TestSvcAlias" }, { "name": "AliasNamespace", "type": "string", "required": true, "description": "服务别名命名空间", "example": "Production" }, { "name": "Service", "type": "string", "required": true, "description": "服务别名所指向的服务名", "example": "TestSvc" }, { "name": "Namespace", "type": "string", "required": true, "description": "服务别名所指向的命名空间", "example": "default" }, { "name": "Comment", "type": "string", "required": false, "description": "服务别名描述", "example": "comment" } ], "required": [ "InstanceId", "Alias", "AliasNamespace", "Service", "Namespace" ] }, { "name": "ModifyGovernanceInstances", "description": "修改治理中心服务实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "GovernanceInstances", "type": "array", "required": true, "description": "服务实例信息。", "example": "无", "item_type": "object", "children": [ { "name": "Service", "type": "string", "required": true, "description": "实例所在服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": true, "description": "实例服务所在命名空间。", "example": "Development" }, { "name": "Weight", "type": "integer", "required": false, "description": "实例负载均衡权重信息。不填默认为100。", "example": "100" }, { "name": "Healthy", "type": "boolean", "required": false, "description": "实例默认健康信息。不填默认为健康。", "example": "true" }, { "name": "Isolate", "type": "boolean", "required": false, "description": "实例隔离信息。不填默认为非隔离。", "example": "true" }, { "name": "Host", "type": "string", "required": false, "description": "实例ip。", "example": "192.168.1.1" }, { "name": "Port", "type": "integer", "required": false, "description": "实例监听端口。", "example": "8080" }, { "name": "Protocol", "type": "string", "required": false, "description": "实例使用协议。不填默认为空。", "example": "grpc" }, { "name": "InstanceVersion", "type": "string", "required": false, "description": "实例版本。不填默认为空。", "example": "v1" }, { "name": "EnableHealthCheck", "type": "boolean", "required": false, "description": "是否启用健康检查。不填默认不启用。", "example": "true" }, { "name": "Ttl", "type": "integer", "required": false, "description": "上报心跳时间间隔。若 EnableHealthCheck 为不启用，则此参数不生效；若 EnableHealthCheck 启用，此参数不填，则默认 ttl 为 5s。", "example": "5" }, { "name": "Id", "type": "string", "required": false, "description": "治理中心服务实例id。", "example": "0662cc4b73fae0a4b911363f25a51e3434de0d8c343" }, { "name": "Metadatas", "type": "array", "required": false, "description": "元数据信息。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] } ] } ], "required": [ "InstanceId", "GovernanceInstances" ] }, { "name": "ModifyGovernanceLaneGroups", "description": "创建泳道组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "引擎实例ID", "example": "ins-123" }, { "name": "LaneGroups", "type": "array", "required": true, "description": "泳道组规则列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "泳道名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "lanegroup-123" }, { "name": "ID", "type": "string", "required": false, "description": "泳道组ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "123345" }, { "name": "TrafficEntries", "type": "array", "required": false, "description": "泳道入口服务列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "EntryType", "type": "string", "required": false, "description": "// type == \"polarismesh.cn/gateway/tse-gateway, 则 selector 为 TSEGatewaySelector // type == \"polarismesh.cn/gateway/spring-cloud-gateway\", 则 selector 为 ServiceGatewaySelector // type == \"polarismesh.cn/service, 则 selector 为 ServiceSelector 注意：此字段可能返回 null，表示取不到有效值。", "example": "polarismesh.cn/gateway/tse-gateway" }, { "name": "TSEGatewaySelector", "type": "object", "required": false, "description": "TSE云原生网关选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关引擎实例ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "gateway-123456" }, { "name": "Services", "type": "array", "required": false, "description": "网关服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"service-1\"]", "item_type": "string" } ] }, { "name": "ServiceGatewaySelector", "type": "object", "required": false, "description": "微服务网关选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ServiceSelector", "type": "object", "required": false, "description": "普通微服务选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ] }, { "name": "Destinations", "type": "array", "required": false, "description": "泳道服务列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "namespace" }, { "name": "Service", "type": "string", "required": true, "description": "服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "service" }, { "name": "Labels", "type": "array", "required": false, "description": "实例标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "LabelKey", "type": "string", "required": false, "description": "标签键 注意：此字段可能返回 null，表示取不到有效值。", "example": "labelkey1" }, { "name": "LabelValue", "type": "string", "required": false, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "value" }, { "name": "LabelType", "type": "string", "required": false, "description": "表达式类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOT_IN" }, { "name": "LabelValueType", "type": "string", "required": false, "description": "值类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" } ] } ] }, { "name": "Description", "type": "string", "required": false, "description": "泳道组描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "123123" }, { "name": "Rules", "type": "array", "required": false, "description": "该泳道组下的所有泳道规则列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ID", "type": "string", "required": false, "description": "泳道规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "71f28761f5e8433a9e656fb290e1dcf8" }, { "name": "Name", "type": "string", "required": false, "description": "泳道名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "rule-1" }, { "name": "LaneGroup", "type": "string", "required": false, "description": "泳道所属泳道组 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-2" }, { "name": "Enable", "type": "boolean", "required": false, "description": "泳道规则启用状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "TrafficLabels", "type": "array", "required": false, "description": "流量标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "CALLER_IP" }, { "name": "Key", "type": "string", "required": false, "description": "key值 注意：此字段可能返回 null，表示取不到有效值。", "example": "$caller_ip" }, { "name": "Value", "type": "object", "required": false, "description": "匹配条件参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ \t\t\t\t\t\t\"type\": \"EXACT\", \t\t\t\t\t\t\"value\": \"test\", \t\t\t\t\t\t\"value_type\": \"TEXT\" \t\t\t\t\t}" } ] }, { "name": "TrafficMatchMode", "type": "string", "required": false, "description": "多个流量标签匹配方式 AND：与 OR：或 注意：此字段可能返回 null，表示取不到有效值。", "example": "AND|OR" }, { "name": "LaneMatchMode", "type": "string", "required": false, "description": "泳道匹配方式 STRICT：严格匹配 PERMISSIVE：宽松匹配 注意：此字段可能返回 null，表示取不到有效值。", "example": "STRICT|PERMISSIVE" }, { "name": "TrafficGray", "type": "object", "required": false, "description": "泳道灰度规则", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "流量灰度规则，按比例灰度或预热方式", "example": "PERCENTAGE" }, { "name": "Percent", "type": "integer", "required": false, "description": "按比例灰度的百分比值1-100", "example": "30" }, { "name": "IntervalSecond", "type": "integer", "required": false, "description": "预热的间隔", "example": "6" }, { "name": "Curvature", "type": "integer", "required": false, "description": "预热的曲度", "example": "2" } ] }, { "name": "Description", "type": "string", "required": false, "description": "泳道规则描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "blue" }, { "name": "LaneLabelValue", "type": "string", "required": false, "description": "泳道标签内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "gray" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "EnableTime", "type": "string", "required": false, "description": "启用时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "Priority", "type": "integer", "required": false, "description": "泳道规则优先级 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Revision", "type": "string", "required": false, "description": "规则摘要 注意：此字段可能返回 null，表示取不到有效值。", "example": "df5bc49fd0084bf3a362b5152d52ad8a" } ] }, { "name": "Revision", "type": "string", "required": false, "description": "规则内容摘要 注意：此字段可能返回 null，表示取不到有效值。", "example": "c123xaweqw" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-01-01 00:00:00" }, { "name": "Consistency", "type": "string", "required": false, "description": "规则一致性状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "Abnormal/Normal/Unknown" } ] } ], "required": [ "InstanceId", "LaneGroups" ] }, { "name": "ModifyGovernanceNamespaces", "description": "修改治理中心命名空间", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse实例id。", "example": "ins-df344df5" }, { "name": "GovernanceNamespaces", "type": "array", "required": true, "description": "命名空间信息。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "命名空间名。", "example": "Development" }, { "name": "Comment", "type": "string", "required": false, "description": "描述信息。", "example": "开发环境" }, { "name": "UserIds", "type": "array", "required": false, "description": "新增的可以操作此命名空间的用户ID列表", "example": "[1,2,3,4]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "新增的可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveUserIds", "type": "array", "required": false, "description": "移除可以操作此命名空间的用户ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveGroupIds", "type": "array", "required": false, "description": "移除可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "ServiceExportTo", "type": "array", "required": false, "description": "该命名空间下的服务对哪些命名空间下可见， 1、为空或者不填写，表示仅当前命名空间可见 2、列表内容仅一个元素，且为字符 *，表示所有命名空间可见（包括新增） 3、列表内容为部份命名空间名称，则只对这些命名空间下可见", "example": "[Namespace-1, Namespace-2]", "item_type": "string" }, { "name": "SyncToGlobalRegistry", "type": "boolean", "required": false, "description": "是否开启同步到全局注册中心", "example": "false" } ] } ], "required": [ "InstanceId", "GovernanceNamespaces" ] }, { "name": "ModifyGovernanceServices", "description": "修改治理中心服务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tse 实例 id。", "example": "ins-df344df5" }, { "name": "GovernanceServices", "type": "array", "required": true, "description": "服务信息。", "example": "provider-demo", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "服务名。", "example": "Producer" }, { "name": "Namespace", "type": "string", "required": true, "description": "服务所属命名空间。", "example": "Development" }, { "name": "Comment", "type": "string", "required": false, "description": "服务描述信息。", "example": "生产者服务。" }, { "name": "Metadatas", "type": "array", "required": false, "description": "服务元数据。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "元数据键名。", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "元数据键值。不填则默认为空字符串。", "example": "tom" } ] }, { "name": "Department", "type": "string", "required": false, "description": "服务所属部门。", "example": "市场部" }, { "name": "Business", "type": "string", "required": false, "description": "服务所属业务。", "example": "采购业务" }, { "name": "UserIds", "type": "array", "required": false, "description": "被添加进来可以操作此命名空间的用户ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "被添加进来可以操作此命名空间的用户组ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveUserIds", "type": "array", "required": false, "description": "从操作此命名空间的用户组ID列表被移除的ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "RemoveGroupIds", "type": "array", "required": false, "description": "从可以操作此命名空间的用户组ID列表中被移除的ID列表", "example": "[1,2,3]", "item_type": "string" }, { "name": "ExportTo", "type": "array", "required": false, "description": "该服务对哪些命名空间可见", "example": "[Namespace-1,Namespace-2]", "item_type": "string" }, { "name": "SyncToGlobalRegistry", "type": "boolean", "required": false, "description": "是否开启同步到全局注册中心", "example": "false" } ] } ], "required": [ "InstanceId", "GovernanceServices" ] }, { "name": "ModifyNativeGatewayServerGroup", "description": "修改云原生API网关实例分组基础信息", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxxxx" }, { "name": "GroupId", "type": "string", "required": true, "description": "网关分组 id", "example": "group-f5da6fd1" }, { "name": "Name", "type": "string", "required": false, "description": "云原生API网关名字, 最多支持60个字符。", "example": "kong-test" }, { "name": "Description", "type": "string", "required": false, "description": "云原生API网关描述信息, 最多支持120个字符。", "example": "kong test" } ], "required": [ "GatewayId", "GroupId" ] }, { "name": "ModifyNativeGatewayServiceSource", "description": "修改网关服务来源", "status": "online", "parameters": [ { "name": "GatewayID", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-dde03567" }, { "name": "SourceID", "type": "string", "required": true, "description": "服务来源实例ID", "example": "ins-5ef8277d" }, { "name": "SourceName", "type": "string", "required": true, "description": "服务来源名称", "example": "nacos-learn-prod" }, { "name": "SourceInfo", "type": "object", "required": false, "description": "服务来源实例额外信息", "example": "无", "children": [ { "name": "Addresses", "type": "array", "required": false, "description": "微服务引擎接入IP地址信息", "example": "[\"127.0.0.1:8080\"]", "item_type": "string" }, { "name": "VpcInfo", "type": "object", "required": false, "description": "微服务引擎VPC信息", "example": "无", "children": [ { "name": "VpcID", "type": "string", "required": false, "description": "微服务引擎VPC信息", "example": "vpc-id" }, { "name": "SubnetID", "type": "string", "required": false, "description": "微服务引擎子网信息", "example": "subnet-id" } ] }, { "name": "Auth", "type": "object", "required": false, "description": "微服务引擎鉴权信息", "example": "无", "children": [ { "name": "Username", "type": "string", "required": false, "description": "用户名", "example": "tse" }, { "name": "Password", "type": "string", "required": false, "description": "账户密码", "example": "tse" }, { "name": "AccessToken", "type": "string", "required": false, "description": "访问凭据 token", "example": "tse" } ] } ] } ], "required": [ "GatewayID", "SourceID", "SourceName" ] }, { "name": "ModifyNetworkAccessStrategy", "description": "修改云原生API网关实例Kong访问策略，支持白名单或者黑名单。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-xxxxxx" }, { "name": "GroupId", "type": "string", "required": true, "description": "分组id", "example": "group-xxx2345s" }, { "name": "NetworkType", "type": "string", "required": true, "description": "网络类型： - Open 公网 - Internal 内网 （暂不支持）", "example": "Open" }, { "name": "Vip", "type": "string", "required": true, "description": "ip地址", "example": "132.0.0.1" }, { "name": "AccessControl", "type": "object", "required": true, "description": "访问控制策略", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": true, "description": "访问模式：Whitelist|Blacklist", "example": "Whitelist" }, { "name": "CidrWhiteList", "type": "array", "required": false, "description": "白名单列表", "example": "[\"0.0.0.0\"]", "item_type": "string" }, { "name": "CidrBlackList", "type": "array", "required": false, "description": "黑名单列表", "example": "[\"100.10.0.0/24\"]", "item_type": "string" } ] } ], "required": [ "GatewayId", "GroupId", "NetworkType", "Vip", "AccessControl" ] }, { "name": "ModifyNetworkBasicInfo", "description": "修改云原生API网关实例网络基本信息，例如带宽以及描述、规格升级，只支持修改客户端公网/内网的信息。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。", "example": "gateway-dde03767" }, { "name": "GroupId", "type": "string", "required": true, "description": "分组id", "example": "group-4se0czf7" }, { "name": "NetworkType", "type": "string", "required": true, "description": "网络类型： - Open 公网ipv4 - Open-IPv6 公网ipv6 - Internal 内网", "example": "Open" }, { "name": "Vip", "type": "string", "required": true, "description": "ip地址", "example": "132.0.0.1" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出流量带宽[1,2048]Mbps", "example": "10" }, { "name": "Description", "type": "string", "required": false, "description": "负载均衡描述", "example": "公网入口" }, { "name": "SlaType", "type": "string", "required": false, "description": "负载均衡的规格类型，支持： - 不传为共享型。 - clb.c2.medium：标准型规格 - clb.c3.small：高阶型1规格 - clb.c3.medium：高阶型2规格 - clb.c4.small：超强型1规格 - clb.c4.medium：超强型2规格 - clb.c4.large：超强型3规格 - clb.c4.xlarge：超强型4规格", "example": "clb.c3.medium" } ], "required": [ "GatewayId", "GroupId", "NetworkType", "Vip" ] }, { "name": "ModifyUpstreamNodeStatus", "description": "修改云原生网关上游实例节点健康状态", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-dde03767" }, { "name": "ServiceName", "type": "string", "required": true, "description": "服务名称", "example": "在线学习服务" }, { "name": "Host", "type": "string", "required": true, "description": "访问IP地址或域名", "example": "10.0.0.1" }, { "name": "Port", "type": "integer", "required": true, "description": "访问端口", "example": "8080" }, { "name": "Status", "type": "string", "required": true, "description": "HEALTHY或UNHEALTHY", "example": "HEALTHY" } ], "required": [ "GatewayId", "ServiceName", "Host", "Port", "Status" ] }, { "name": "OpenWafProtection", "description": "开启 WAF 防护", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Type", "type": "string", "required": true, "description": "防护资源的类型。 - Global 实例 - Service 服务 - Route 路由 - Object 对象（接口暂不支持）", "example": "Global" }, { "name": "List", "type": "array", "required": false, "description": "当资源类型 Type 是 Service 或 Route 的时候，传入的服务或路由的列表", "example": "2a212560-220a-46f6-b139-3238eb8ea041", "item_type": "string" } ], "required": [ "GatewayId", "Type" ] }, { "name": "PublishConfigFiles", "description": "发布配置文件", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE实例id", "example": "ins-df344df5\t" }, { "name": "ConfigFileReleases", "type": "object", "required": true, "description": "配置文件发布", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "配置文件发布id", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件发布名称", "example": "application" }, { "name": "Namespace", "type": "string", "required": false, "description": "配置文件发布命名空间", "example": "namespaceName" }, { "name": "Group", "type": "string", "required": false, "description": "配置文件发布组", "example": "provider-demo" }, { "name": "FileName", "type": "string", "required": false, "description": "配置文件发布文件名称", "example": "application.yml" }, { "name": "Content", "type": "string", "required": false, "description": "配置文件发布内容", "example": "hello" }, { "name": "Comment", "type": "string", "required": false, "description": "配置文件发布注释", "example": "comment" }, { "name": "Md5", "type": "string", "required": false, "description": "配置文件发布Md5", "example": "md5hash" }, { "name": "Version", "type": "integer", "required": false, "description": "配置文件发布版本", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "配置文件发布创建时间", "example": "2024-12-29 16:23:00" }, { "name": "CreateBy", "type": "string", "required": false, "description": "配置文件发布创建者", "example": "usera" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "配置文件发布修改时间", "example": "2024-12-29 16:23:00" }, { "name": "ModifyBy", "type": "string", "required": false, "description": "配置文件发布修改者", "example": "usera" }, { "name": "ReleaseDescription", "type": "string", "required": false, "description": "发布描述", "example": "config-desc" }, { "name": "Active", "type": "boolean", "required": false, "description": "是否生效", "example": "true" }, { "name": "Format", "type": "string", "required": false, "description": "格式", "example": "yaml" }, { "name": "ConfigFileId", "type": "string", "required": false, "description": "配置文件ID", "example": "name" }, { "name": "ConfigFileSupportedClient", "type": "integer", "required": false, "description": "配置文件类型", "example": "client_sdk" }, { "name": "ConfigFilePersistent", "type": "object", "required": false, "description": "配置文件持久化", "example": "无", "children": [ { "name": "Encoding", "type": "string", "required": false, "description": "文件编码", "example": "UTF-8" }, { "name": "Path", "type": "string", "required": false, "description": "文件下发路径", "example": "/path/var" }, { "name": "PostCmd", "type": "string", "required": false, "description": "文件后置命令", "example": "echo aaa;\\n echo ccc" } ] } ] }, { "name": "StrictEnable", "type": "boolean", "required": false, "description": "控制开启校验配置版本是否已经存在", "example": "true" } ], "required": [ "InstanceId", "ConfigFileReleases" ] }, { "name": "RestartSREInstance", "description": "重启微服务引擎实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "微服务引擎实例Id", "example": "sre-12345678" }, { "name": "EnvTypes", "type": "array", "required": false, "description": "重启的环境类型（PROD，DEV，UAT等）", "example": "[\"PROD\",\"DEV\"]", "item_type": "string" }, { "name": "NodeName", "type": "string", "required": false, "description": "指定需要重启的实例节点（当前仅支持zk单节点重启）", "example": "zookeeper-0" } ], "required": [ "InstanceId" ] }, { "name": "RollbackConfigFileReleases", "description": "回滚配置发布", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TSE实例id", "example": "ins-0e02e26d" }, { "name": "RollbackConfigFileReleases", "type": "array", "required": true, "description": "回滚发布", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "配置文件发布id", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "配置文件发布名称", "example": "application" }, { "name": "Namespace", "type": "string", "required": false, "description": "配置文件发布命名空间", "example": "namespaceName" }, { "name": "Group", "type": "string", "required": false, "description": "配置文件发布组", "example": "provider-demo" }, { "name": "FileName", "type": "string", "required": false, "description": "配置文件发布文件名称", "example": "application.yml" }, { "name": "Content", "type": "string", "required": false, "description": "配置文件发布内容", "example": "hello" }, { "name": "Comment", "type": "string", "required": false, "description": "配置文件发布注释", "example": "comment" }, { "name": "Md5", "type": "string", "required": false, "description": "配置文件发布Md5", "example": "md5hash" }, { "name": "Version", "type": "integer", "required": false, "description": "配置文件发布版本", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "配置文件发布创建时间", "example": "2024-12-29 16:23:00" }, { "name": "CreateBy", "type": "string", "required": false, "description": "配置文件发布创建者", "example": "usera" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "配置文件发布修改时间", "example": "2024-12-29 16:23:00" }, { "name": "ModifyBy", "type": "string", "required": false, "description": "配置文件发布修改者", "example": "usera" }, { "name": "ReleaseDescription", "type": "string", "required": false, "description": "发布描述", "example": "config-desc" }, { "name": "Active", "type": "boolean", "required": false, "description": "是否生效", "example": "true" }, { "name": "Format", "type": "string", "required": false, "description": "格式", "example": "yaml" }, { "name": "ConfigFileId", "type": "string", "required": false, "description": "配置文件ID", "example": "name" }, { "name": "ConfigFileSupportedClient", "type": "integer", "required": false, "description": "配置文件类型", "example": "client_sdk" }, { "name": "ConfigFilePersistent", "type": "object", "required": false, "description": "配置文件持久化", "example": "无", "children": [ { "name": "Encoding", "type": "string", "required": false, "description": "文件编码", "example": "UTF-8" }, { "name": "Path", "type": "string", "required": false, "description": "文件下发路径", "example": "/path/var" }, { "name": "PostCmd", "type": "string", "required": false, "description": "文件后置命令", "example": "echo aaa;\\n echo ccc" } ] } ] } ], "required": [ "InstanceId", "RollbackConfigFileReleases" ] }, { "name": "UnbindAutoScalerResourceStrategyFromGroups", "description": "弹性伸缩策略批量解绑网关分组", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-4a34cf5f" }, { "name": "StrategyId", "type": "string", "required": true, "description": "策略ID", "example": "strategy-7bb4fcb0" }, { "name": "GroupIds", "type": "array", "required": true, "description": "网关分组ID列表", "example": "group-4se0czf7", "item_type": "string" } ], "required": [ "GatewayId", "StrategyId", "GroupIds" ] }, { "name": "UpdateCloudNativeAPIGatewayCertificateInfo", "description": "修改云原生网关证书信息", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-962b7d7c" }, { "name": "Id", "type": "string", "required": true, "description": "证书id", "example": "f931336a-44f8-4381-bcc2-c9340f0239c9" }, { "name": "BindDomains", "type": "array", "required": true, "description": "绑定的域名列表", "example": "[\"tencent.com\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": false, "description": "证书名称", "example": "tencent.com" } ], "required": [ "GatewayId", "Id", "BindDomains" ] }, { "name": "UpdateCloudNativeAPIGatewaySpec", "description": "修改云原生API网关实例的节点规格信息，例如节点扩缩容或者升降配", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "云原生API网关实例ID。 只支持后付费实例", "example": "gateway-xxxxxx" }, { "name": "GroupId", "type": "string", "required": true, "description": "网关分组id", "example": "group-xxxx1234" }, { "name": "NodeConfig", "type": "object", "required": true, "description": "网关分组节点规格配置。", "example": "无", "children": [ { "name": "Specification", "type": "string", "required": true, "description": "节点配置, 1c2g|2c4g|4c8g|8c16g。", "example": "1c2g" }, { "name": "Number", "type": "integer", "required": true, "description": "节点数量，2-9。", "example": "2" } ] } ], "required": [ "GatewayId", "GroupId", "NodeConfig" ] }, { "name": "UpdateEngineInternetAccess", "description": "修改引擎公网访问配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "引擎ID", "example": "ins-389a8c12" }, { "name": "EngineType", "type": "string", "required": true, "description": "引擎类型", "example": "eureka" }, { "name": "EnableClientInternetAccess", "type": "boolean", "required": false, "description": "是否开启客户端公网访问，true开 false关", "example": "true" } ], "required": [ "InstanceId", "EngineType" ] }, { "name": "UpdateUpstreamHealthCheckConfig", "description": "更新云原生网关健康检查配置", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关ID", "example": "gateway-dde03767" }, { "name": "Name", "type": "string", "required": true, "description": "网关服务名称", "example": "service1" }, { "name": "HealthCheckConfig", "type": "object", "required": true, "description": "健康检查配置", "example": "无", "children": [ { "name": "EnableActiveHealthCheck", "type": "boolean", "required": false, "description": "开启主动健康检查", "example": "true" }, { "name": "ActiveHealthCheck", "type": "object", "required": false, "description": "主动健康检查配置", "example": "无", "children": [ { "name": "HealthyInterval", "type": "integer", "required": false, "description": "主动健康检查健康探测间隔，单位：秒，0表示不开启", "example": "0" }, { "name": "UnHealthyInterval", "type": "integer", "required": false, "description": "主动健康检查异常探测间隔，单位：秒，0表示不开启", "example": "0" }, { "name": "HttpPath", "type": "string", "required": false, "description": "在 GET HTTP 请求中使用的路径，以作为主动运行状况检查的探测器运行。默认： ”/”。", "example": "/v1/users" }, { "name": "Timeout", "type": "float", "required": false, "description": "GET HTTP 请求的超时时间，单位：秒。默认 60。", "example": "60" } ] }, { "name": "EnablePassiveHealthCheck", "type": "boolean", "required": false, "description": "开启被动健康检查", "example": "true" }, { "name": "PassiveHealthCheck", "type": "object", "required": false, "description": "被动健康检查配置", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "后端target协议类型，被动健康检查支持http和tcp，主动健康检查支持http", "example": "http" } ] }, { "name": "Successes", "type": "integer", "required": false, "description": "连续健康阈值，单位：次", "example": "5" }, { "name": "Failures", "type": "integer", "required": false, "description": "连续异常阈值，单位：次", "example": "5" }, { "name": "Timeouts", "type": "integer", "required": false, "description": "超时阈值，单位：次", "example": "5" }, { "name": "HealthyHttpStatuses", "type": "array", "required": false, "description": "健康HTTP状态码", "example": "200", "item_type": "integer" }, { "name": "UnhealthyHttpStatuses", "type": "array", "required": false, "description": "异常HTTP状态码", "example": "500", "item_type": "integer" }, { "name": "ZeroWeightHeathCheck", "type": "boolean", "required": false, "description": "健康检查支持权重为0节点", "example": "false" } ] } ], "required": [ "GatewayId", "Name", "HealthCheckConfig" ] }, { "name": "UpdateUpstreamTargets", "description": "更新网关上游实例列表，仅支持IPList服务类型", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID", "example": "gateway-dde03767" }, { "name": "Name", "type": "string", "required": true, "description": "服务名称或ID", "example": "service1" }, { "name": "Targets", "type": "array", "required": false, "description": "实例列表", "example": "无", "item_type": "object", "children": [ { "name": "Host", "type": "string", "required": true, "description": "Host", "example": "8.8.8.8" }, { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "100" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重", "example": "10" }, { "name": "Health", "type": "string", "required": false, "description": "健康状态", "example": "HEALTHY" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间", "example": "2024-11-25 10:49:23" }, { "name": "Source", "type": "string", "required": false, "description": "Target的来源", "example": "AutoScaling" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例ID", "example": "ins-ze3124da" }, { "name": "CvmInstanceName", "type": "string", "required": false, "description": "CVM实例名称", "example": "在线学习服务" }, { "name": "Tags", "type": "array", "required": false, "description": "target标签", "example": "learn", "item_type": "string" } ] } ], "required": [ "GatewayId", "Name" ] } ] }