AI 助理
备案控制台
文档
输入文档关键字查找
首页 微服务引擎 开发参考 API参考（mse） API参考指南 API概览

API概览

更新时间：
产品详情
相关技术圈
我的收藏
本产品（微服务引擎/2019-05-31）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

标签

API标题API概述
ListTagResources获取标签列表查标签接口。
UntagResources删除标签删标签接口。
TagResources添加标签为指定的资源打上标签。

注册配置中心

API标题API概述
迁移上云迁移上云
UpdateMigrationTask更新迁移上云任务调用接口更新迁移上云任务。
AddMigrationTask添加迁移上云任务调用接口添加迁移任务。
ListMigrationTask查询迁移上云任务调用接口查询迁移上云任务。
DeleteMigrationTask删除迁移上云任务调用接口删除迁移上云任务。
风险评估风险评估
PutClusterHealthCheckTask发起风险评估检查任务对当前集群发起一次风险评估的检查任务。
OrderClusterHealthCheckRiskNotice订阅风险项通知是否订阅风险项通知功能。
ListClusterHealthCheckTask获取风险评估任务列表获取历史风险评估任务列表。
Nacos配置Nacos配置
ListConfigTrack获取Nacos配置中心推送轨迹获取Nacos配置中心的轨迹数据。
CreateNacosConfig创建Nacos配置创建一个Nacos配置。
DeleteNacosConfig删除Nacos配置删除Nacos配置。
DeleteNacosConfigs批量删除Nacos配置批量删除多个Nacos配置。
UpdateNacosConfig更新Nacos配置更新一个Nacos配置。
ListListenersByConfig查询配置监听者根据配置信息查询监听者。
ListListenersByIp根据IP查询监听者列表根据IP查询监听者列表。
GetNacosConfig获取Nacos配置获取Nacos配置。
GetNacosHistoryConfig查询Nacos配置历史查询Nacos配置变更历史列表。
ListNacosConfigs查询Nacos配置列表查询Nacos配置列表。
ListNacosHistoryConfigs查询Nacos配置历史列表查询Nacos配置历史列表。
CloneNacosConfig克隆Nacos配置将已有的Nacos配置克隆到其他命名空间。
ExportNacosConfig导出Nacos配置导出指定的Nacos配置。
GetImportFileUrl获取文件上传地址获取Nacos配置导入时获取文件的上传地址。
ImportNacosConfig导入Nacos配置使用配置文件导入Nacos配置。
Nacos服务Nacos服务
ListNamingTrack获取Nacos注册中心推送轨迹获取Nacos注册中心的轨迹数据。
CreateNacosService创建Nacos服务创建Nacos服务。
ListAnsServices查询Nacos服务详情查询Nacos服务详情。
DeleteNacosService删除Nacos服务删除一个Nacos服务。
UpdateNacosService更新Nacos服务更新Nacos服务。
UpdateNacosCluster更新Nacos集群更新Nacos集群信息。
ListAnsServiceClusters查询集群服务详情查询Nacos服务的集群列表。
CreateNacosInstance创建Nacos实例创建Nacos实例。
DeleteNacosInstance删除Nacos实例删除Nacos服务下持久化实例。
UpdateNacosInstance更新Nacos实例信息更新注册在Nacos中的实例信息。
ListAnsInstances查询Nacos服务实例列表查询Nacos服务实例列表。
GetServiceListeners获取nacos服务监听者获取目标服务的监听者列表。
监控管理监控管理
QueryMonitor查询监控信息查询监控信息。
公网白名单管理公网白名单管理
UpdateAcl更新白名单修改白名单。
集群管理集群管理
QueryInstancesInfo查询集群静态信息查询指定集群的运行时数据。
QueryClusterInfo查询集群静态信息查询集群的静态信息。
QueryClusterDetail查询集群详情接口查询集群详情。
CreateCluster创建注册配置中心集群创建一个注册配置中心（ZooKeeper、Nacos等）集群。
DeleteCluster删除集群删除一个注册配置中心集群。
UpdateCluster更新集群信息修改集群信息。
UpdateConfig更新集群配置更新集群配置。
ListClusters查询集群列表查询注册配置中心集群列表。
ListClusterTypes查询引擎类型查询支持开通的引擎类型。
ListClusterVersions查询集群版本查询支持的集群版本信息。
QueryClusterSpecification查询集群规格查询支持的集群规格列表。
QueryClusterDiskSpecification查询集群磁盘规格查询支持的集群磁盘规格信息。
ListInstanceCount集群可开通的节点数列举集群可开通的节点数。
QueryConfig查询集群配置查询集群配置信息。
GetImage查询本地单个镜像信息查询当前版本可升级的最大版本号。
UpdateImage更新集群镜像升级目标集群的版本号。
GetMseFeatureSwitch获取MSE能力开关获取MSE能力开关。
QueryBusinessLocations查询地域信息查询地域信息。
ListClusterConnectionTypes查询集群连接信息查询支持的集群连接类型。
QuerySlbSpec查询SLB类型查询SLB类型。
UpdateClusterSpec更新集群规格更新注册配置中心集群节点数或规格（支持按量付费和包年包月）。
RestartCluster重启集群重启注册配置中心集群。
RetryCluster重试集群创建超时时，调用RetryCluster接口重试集群。
命名空间命名空间
CreateEngineNamespace创建引擎命名空间创建一个Nacos命名空间。
DeleteEngineNamespace删除引擎命名空间删除Nacos命名空间。
UpdateEngineNamespace更新引擎命名空间更新引擎命名空间。
GetEngineNamepace查询引擎命名空间查询Nacos命名空间列表。
ListEngineNamespaces查询引擎命名空间列表查询Nacos命名空间列表。
Zookeeper数据节点Zookeeper数据节点
ImportZookeeperData发起Zookeeper数据导入发起Zookeeper数据导入任务，使Zookeeper集群开始导入目标URL内的数据。
GetZookeeperDataImportUrl获取Zookeeper数据导入URL获取上传数据文件的URL，用户能通过此URL上传Zookeeper待导入的数据文件。
ExportZookeeperDatazookeeper发起导出数据任务发起导出zookeeper数据任务。
ListExportZookeeperDataZookeeper导出任务列表列出Zookeeper的历史数据导出任务列表。
CreateZnode创建ZooKeeper数据节点创建Zookeeper数据节点。
DeleteZnode删除ZooKeeper数据节点释放Zookeeper数据节点。
UpdateZnode更新ZooKeeper数据节点更新Zookeeper数据节点。
ListZnodeChildren查询ZooKeeper子节点查询ZooKeeper数据子节点。
QueryZnodeDetail查询ZooKeeper数据节点查询ZooKeeper数据节点信息。
ListZkTrack查询ZooKeeper轨迹数据获取ZooKeeper的轨迹数据。

微服务治理中心

API标题API概述
流量防护流量防护
ListSentinelBlockFallbackDefinitions获取流量防护自定义行为获取流量防护自定义行为。
BindSentinelBlockFallbackDefinition绑定流量防护行为绑定流量防护行为。
ListIsolationRules获取隔离规则列表查询隔离规则。
CreateIsolationRule创建隔离规则创建隔离规则。
DeleteIsolationRules删除隔离规则删除隔离规则。
UpdateIsolationRule更新隔离规则更新隔离规则。
DeleteCircuitBreakerRules删除熔断规则删除熔断规则。
DeleteFlowRules删除流控规则删除流控规则。
UpdateFlowRule更新流控规则更新流控规则。
ListFlowRules获取流控规则列表获取流控规则列表。
CreateFlowRule创建流控规则创建流控规则。
CreateCircuitBreakerRule创建熔断规则创建熔断规则。
ListCircuitBreakerRules获取熔断规则列表获取熔断规则列表。
UpdateCircuitBreakerRule更新熔断规则更新熔断规则。
服务鉴权服务鉴权
ListAuthPolicy获取服务鉴权规则列表通过ListAuthPolicy接口查询服务鉴权规则列表。
UpdateAuthPolicy更新服务鉴权规则通过UpdateAuthPolicy接口更新服务鉴权规则。
AddAuthPolicy创建服务鉴权规则通过AddAuthPolicy接口创建服务鉴权规则。
RemoveAuthPolicy删除服务鉴权规则通过RemoveAuthPolicy接口删除服务鉴权规则。
服务查询服务查询
GetServiceMethodPage获取服务方法列表获取服务接口列表。
GetServiceListPage获取服务列表获取服务列表
GetServiceList查询应用服务信息通过GetServiceList接口查询应用服务信息。
全链路灰度全链路灰度
CreateOrUpdateSwimmingLaneGroup创建或者更新全链路灰度泳道组用于创建或者更新全链路灰度泳道组。
DeleteSwimmingLaneGroup删除全链路泳道组用于删除全链路泳道组。
CreateOrUpdateSwimmingLane创建或者更新全链路灰度泳道用于创建或者更新全链路灰度泳道。
DeleteSwimmingLane删除全链路泳道用于删除全链路泳道。
QueryAllSwimmingLaneGroup查询所有泳道组用于查询所有泳道组。
QueryAllSwimmingLane查询当前泳道组内所有泳道获取所有泳道信息
GetTagsBySwimmingLaneGroupId获取当前泳道组内的所有标签用于获取当前泳道组内的所有标签。
QuerySwimmingLaneById通过泳道ID查询泳道信息用于通过泳道ID查询泳道信息。
ListAppBySwimmingLaneGroupTags获取泳道组内的指定标签的应用列表获取指定泳道组内的指定标签的应用列表。
ListAppBySwimmingLaneGroupTag获取当前泳道组内的指定标签的应用列表用于获取当前泳道组内的指定标签的应用列表。
无损上下线无损上下线
GetLosslessRuleByApp获取指定应用无损上下线规则获取指定应用无损上下线规则。
ModifyLosslessRule修改无损规则修改用户无损上下线配置。
FetchLosslessRuleList获取无损上下线规则列表获取无损上下线规则列表。
应用管理应用管理
GetApplicationList获取应用列表通过GetApplicationList接口获取应用列表。
CreateMseServiceApplication创建应用创建应用。
CreateApplication创建应用创建应用。
GetOverview查询应用概览查询治理概览信息。
RemoveApplication删除应用删除单个应用。
K8s集群治理K8s集群治理
ModifyGovernanceKubernetesCluster更新已接入服务治理的集群信息修改已接入服务治理的集群信息。
GetGovernanceKubernetesCluster查询已接入服务治理的集群信息获取服务治理的kubernetes集群信息。
QueryGovernanceKubernetesCluster获取微服务治理K8s集群信息列表获取微服务治理K8s集群信息列表。
标签路由标签路由
ApplyTagPolicies修改标签路由规则修改标签路由规则。
ListApplicationsWithTagRules获取应用的路由规则通过ListApplicationsWithTagRules接口获取应用的路由规则。
消息灰度消息灰度
GetAppMessageQueueRoute获取应用消息灰度信息获取应用消息灰度相关的信息。
UpdateMessageQueueRoute更新应用消息灰度的配置更新应用消息灰度的配置。

云原生网关

API标题API概述
插件市场插件市场
GetPlugins获取插件列表获取插件市场插件。
GetPluginConfig获取插件配置获取插件配置。
CreatePluginConfig创建插件配置创建插件配置。
UpdatePluginConfig更新插件配置更新插件配置。
DeletePluginConfig删除插件配置删除插件配置。
域名证书域名证书
AddSSLCert添加网关域名关联证书网关域名关联证书，证书可托管在云盾服务。
AddGatewayDomain添加网关关联域名添加网关关联域名。
DeleteGatewayDomain删除网关关联域名删除网关关联域名。
UpdateSSLCert更换证书更换证书。
UpdateGatewayDomain更新关联域名信息修改关联域名信息。
ListSSLCert查询网关证书列表获取网关证书列表。
ListGatewayDomain查询网关已关联域名列表查询网关已关联域名列表。
GetGatewayDomainDetail查询网关域名详情查询网关域名详情。
网关管理网关管理
AddGateway添加网关添加网关。
ListGatewayZone获取网关可用区列表获取网关可用区列表。
AddGatewaySlb关联网关SLB关联SLB。
AddSecurityGroupRule添加网关安全组规则添加网关安全组规则。
DeleteGateway删除网关信息删除指定网关。
DeleteGatewaySlb取消关联网关SLB取消关联SLB。
DeleteSecurityGroupRule删除网关安全组规则删除网关安全组规则。
UpdateGatewayOption更新网关参数更新网关参数。
UpdateGatewayName更新网关名称修改网关名称。
QueryGatewayRegion查询网关支持地域查询网关支持的地域。
QueryGatewayType查询网关可用类型查询网关可用类型。
GetGateway查询网关信息获取网关的所属VPC，所属交换机等基本信息。
ListGateway查询网关信息列表查询该网关列表信息。
ListGatewaySlb查询网关入口SLB查询网关入口SLB。
GetGatewayOption查询网关选项获取网关全局参数。
ListSecurityGroupRule查询网关安全组列表查询网关安全组列表。
ListSecurityGroup获取安全组列表获取安全组列表。
UpdateGatewaySpec更新网关规格更新云原生网关集群节点数或规格（支持按量付费和包年包月）。
SelectGatewaySlb查询网关SLB接口，查询用户已有（启动中状态无监听）SLB。
服务管理服务管理
AddServiceSource创建服务来源创建Nacos服务来源。
AddGatewayServiceVersion添加网关服务版本添加服务版本。
DeleteServiceSource删除网关服务来源删除网关服务来源。
DeleteGatewayServiceVersion删除网关服务版本删除网关服务版本。
DeleteGatewayService删除网关服务删除网关服务。
UpdateGatewayServiceTrafficPolicy更新服务流量策略更新服务流量策略。
UpdateGatewayServiceVersion更新服务版本更新修改服务。
ListServiceSource查询网关已关联的服务来源列表查询已关联来源列表。
ListGatewayService查询网关已订阅的服务列表查询网关已订阅的服务列表。
GetMseSource查询MSE Nacos来源查询已有MSE Nacos。
GetKubernetesSource查询ACK集群来源信息获取当前所有ACK集群来源信息。
GetGatewayServiceDetail查询网关服务详情查询服务详情。
UpdateServiceSource更新服务来源修改云原生网关服务来源，目前仅支持对含有Ingress监听配置的ACK容器服务进行修改操作。
ImportServices创建网关服务订阅导入网关的服务。
PullServices查询指定来源可导入服务信息查询指定来源可导入服务信息。
UpdateGatewayServiceCheck更新服务健康检查策略更新云原生网关指定服务的健康检查策略。
安全能力安全能力
UpdateGatewayRouteAuth更新路由鉴权配置更新路由鉴权配置。
ListGatewayAuthConsumerResource获取网关鉴权消费者的授权列表获取网关鉴权消费者的授权列表。
UpdateGatewayAuthConsumer更新网关鉴权消费者更新网关鉴权消费者。
ListGatewayRouteOnAuth获取开启鉴权的路由列表获取开启鉴权的路由列表。
ListGatewayAuthConsumer获取网关鉴权消费者列表获取网关鉴权消费者列表。
UpdateGatewayAuthConsumerResource更新网关鉴权消费者的授权列表更新网关鉴权消费者的授权列表。
UpdateGatewayAuthConsumerStatus更新网关鉴权消费者状态更新网关鉴权消费者状态。
AddGatewayAuthConsumer新增网关鉴权消费者新增网关鉴权消费者。
DeleteGatewayAuthConsumerResource删除网关鉴权消费者的授权删除网关鉴权消费者的授权。
UpdateGatewayAuthConsumerResourceStatus更新网关鉴权消费者的授权状态更新网关鉴权消费者的授权状态。
DeleteGatewayAuthConsumer删除网关鉴权消费者删除网关鉴权消费者。
GetGatewayAuthConsumerDetail获取网关鉴权消费者细节获取网关鉴权消费者细节。
AddBlackWhiteList添加黑白名单添加黑白名单。
UpdateBlackWhiteList更新网关黑白名单更新网关黑白名单。
GatewayBlackWhiteList获取网关黑白名单列表获取网关黑白名单列表。
GetBlackWhiteList查询网关黑白名单查询网关黑白名单。
AddGatewayAuth创建网关鉴权创建网关鉴权。
GetGatewayAuthDetail获取网关鉴权详情获取网关鉴权详情。
AddAuthResource添加鉴权资源网关鉴权-创建授权信息。
DeleteAuthResource删除网关授权资源删除授权资源。
路由配置路由配置
AddGatewayRoute添加网关路由添加网关路由。
DeleteGatewayRoute删除网关路由删除网关路由。
UpdateGatewayRouteHTTPRewrite更新网关路由的重写策略更新网关路由的重写策略。
UpdateGatewayRoute更新网关路由更新网关路由。
UpdateGatewayRouteCORS修改网关路由跨域策略修改网关路由跨域策略。
UpdateGatewayRouteHeaderOp修改网关路由Header设置修改网关路由Header设置。
UpdateGatewayRouteTimeout修改网关路由超时策略修改网关路由超时策略。
UpdateGatewayRouteRetry修改网关路由重试策略修改网关路由重试策略。
GetGatewayRouteDetail查询网关路由详情查询网关路由详情。
ListGatewayRoute网关路由列表查询网关路由列表。
UpdateGatewayRouteWafStatus更新路由防护状态更新路由waf状态。
ApplyGatewayRoute发布网关路由发布网关路由。
OfflineGatewayRoute下线网关路由下线网关路由。
参数配置参数配置
GetGatewayConfig获取网关参数配置获取网关参数配置。
EnableProxyProtocol开启Proxy协议开启Proxy协议。如果网关入口流量使用NLB接入，如果不开启则无法获取客户端的真实IP，开启后对于非Proxy协议请求没有影响。
EnableHttp2开启HTTP 2服务端与客户端协商时是否使用http2（修改后1～2分钟后生效）
PreserveHeaderFormat开启保持请求header头大小写作用于请求和响应环节，是否保持请求header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写。
策略配置策略配置
CreateGatewayFlowRule创建网关流控规则创建网关流控规则。
DeleteGatewayFlowRule删除网关流控规则删除该网关流控规则。
UpdateGatewayFlowRule更新网关流控规则更新该网关流控规则。
ListGatewayFlowRule查询网关流控规则查询该网关流控规则。
CreateGatewayCircuitBreakerRule创建网关熔断规则创建网关熔断规则。
DeleteGatewayCircuitBreakerRule删除网关熔断规则删除该网关熔断规则。
UpdateGatewayCircuitBreakerRule更新网关熔断规则更新该网关熔断规则。
ListGatewayCircuitBreakerRule查询网关熔断规则查询该网关熔断规则。
CreateGatewayIsolationRule创建网关并发规则创建网关并发规则。
DeleteGatewayIsolationRule删除网关并发规则删除该网关并发规则。
UpdateGatewayIsolationRule更新网关并发规则更新该网关并发规则。
ListGatewayIsolationRule查询网关并发规则查询该网关并发规则。

其他

API标题API概述
InitializeServiceLinkRole创建MSE SLR创建MSE SLR。
QueryNamespace查询MSE命名空间查询MSE命名空间。
DeleteNamespace删除MSE命名空间删除MSE命名空间。
GetApplicationInstanceList获取应用实例信息查询微服务应用实例列表。
CloneSentinelRuleFromAhasAHAS规则迁移AHAS规则迁移。
ChangeResourceGroup更改实例所在资源组资源转组
UpdateNacosGrayConfig更新Nacos灰度配置信息更新灰度配置，包含基于Beta发布和标签灰度的灰度配置信息更新
上一篇：API参考指南下一篇：服务接入点
文档推荐