首页 微服务引擎MSE API参考指南 API概览

API概览

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

标签

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

注册配置中心

API标题API概述
Nacos配置Nacos配置
CreateNacosConfig创建Nacos配置创建一个Nacos配置。
DeleteNacosConfig删除Nacos配置删除Nacos配置。
DeleteNacosConfigs批量删除Nacos配置批量删除多个Nacos配置。
UpdateNacosConfig更新Nacos配置更新一个Nacos配置。
ListListenersByConfig查询配置监听者根据配置信息查询监听者。
ListListenersByIp根据IP查询监听者列表根据IP查询监听者列表。
GetImportFileUrl获取文件上传地址获取Nacos配置导入时获取文件的上传地址。
GetNacosConfig获取Nacos配置获取Nacos配置。
GetNacosHistoryConfig查询Nacos配置历史查询Nacos配置变更历史列表。
ListNacosConfigs查询Nacos配置列表查询Nacos配置列表。
ListNacosHistoryConfigs查询Nacos配置历史列表查询Nacos配置历史列表。
CloneNacosConfig克隆Nacos配置将已有的Nacos配置克隆到其他命名空间。
ExportNacosConfig导出Nacos配置导出指定的Nacos配置。
ImportNacosConfig导入Nacos配置使用配置文件导入Nacos配置。
Nacos服务Nacos服务
CreateNacosService创建Nacos服务创建Nacos服务。
DeleteNacosService删除Nacos服务调用DeleteNacosService接口删除一个Nacos服务。
UpdateNacosService更新Nacos服务调用UpdateNacosService接口更新Nacos服务。
ListAnsServices查询Nacos服务详情查询Nacos服务详情。
UpdateNacosCluster更新Nacos集群更新Nacos集群信息。
ListAnsServiceClusters查询集群服务详情查询Nacos服务的集群列表。
CreateNacosInstance创建Nacos实例创建Nacos实例。
DeleteNacosInstance删除Nacos实例调用DeleteNacosInstance接口删除Nacos服务下持久化实例。
UpdateNacosInstance更新Nacos实例信息更新注册在Nacos中的实例信息。
ListAnsInstances查询Nacos服务实例列表查询Nacos服务实例列表。
GetServiceListeners获取nacos服务监听者获取目标服务的监听者列表。
Eureka服务Eureka服务
ListEurekaServices查询Eureka服务列表查询Eureka服务列表。
ListEurekaInstances查询Eureka实例列表查询Eureka实例列表。
监控管理监控管理
QueryMonitor查询监控信息调用QueryMonitor接口查询监控信息。
白名单管理白名单管理
UpdateAcl更新白名单调用UpdateAcl接口修改白名单。
集群管理集群管理
CreateCluster创建注册配置中心集群创建一个注册配置中心（ZooKeeper、Nacos等）集群。
DeleteCluster删除集群删除一个注册配置中心集群。
UpdateCluster更新集群信息调用UpdateCluster接口修改集群信息。
UpdateConfig更新集群配置调用UpdateConfig接口更新集群配置。
UpdateImage更新集群镜像升级目标集群的版本号。
ListClusters查询集群列表查询注册配置中心集群列表。
ListClusterTypes查询引擎类型查询支持开通的引擎类型。
ListClusterVersions查询集群版本调用ListClusterVersions接口，查询支持的集群版本信息。
QueryClusterDetail查询集群详情接口查询集群详情。
QueryClusterSpecification查询集群规格查询支持的集群规格列表。
QueryClusterDiskSpecification查询集群磁盘规格调用QueryClusterDiskSpecification接口，查询支持的集群磁盘规格信息。
QueryConfig查询集群配置查询集群配置信息。
GetImage查询本地单个镜像信息查询当前版本可升级的最大版本号。
GetMseFeatureSwitch获取MSE能力开关调用GetMseFeatureSwitch接口获取MSE能力开关。
QueryBusinessLocations查询地域信息查询地域信息。
ListClusterConnectionTypes查询集群连接信息调用ListClusterConnectionTypes接口，查询支持的集群连接类型。
QuerySlbSpec查询SLB类型调用QuerySlbSpec接口查询SLB类型。
UpdateClusterSpec更新集群规格更新注册配置中心集群节点数或规格（仅针对按量付费）。
RestartCluster重启集群重启注册配置中心集群。
RetryCluster重试集群创建超时时，调用RetryCluster接口重试集群。
ListInstanceCount集群可开通的节点数列举集群可开通的节点数。
UpgradeCluster升级集群调用UpgradeCluster接口升级集群版本。
命名空间命名空间
CreateEngineNamespace创建引擎命名空间创建一个Nacos命名空间。
DeleteEngineNamespace删除引擎命名空间删除Nacos命名空间。
UpdateEngineNamespace更新引擎命名空间调用UpdateEngineNamespace接口，更新引擎命名空间。
GetEngineNamepace查询引擎命名空间查询Nacos命名空间列表。
ListEngineNamespaces查询引擎命名空间列表查询Nacos命名空间列表。
Zookeeper数据节点Zookeeper数据节点
CreateZnode创建ZooKeeper数据节点创建Zookeeper数据节点。
DeleteZnode删除ZooKeeper数据节点释放Zookeeper数据节点。
UpdateZnode更新ZooKeeper数据节点调用UpdateZnode接口，更新Zookeeper数据节点。
ListZnodeChildren查询ZooKeeper子节点查询ZooKeeper数据子节点。
QueryZnodeDetail查询ZooKeeper数据节点调用QueryZnodeDetail接口，查询ZooKeeper数据节点信息。
ListZkTrack查询ZooKeeper轨迹数据调用ListZkTrack接口，获取ZooKeeper的轨迹数据。

微服务治理中心

API标题API概述
标签路由标签路由
ApplyTagPolicies修改标签路由规则调用ApplyTagPolicies接口修改标签路由规则。
ListApplicationsWithTagRules获取应用的路由规则通过ListApplicationsWithTagRules接口获取应用的路由规则。
服务查询服务查询
GetServiceList查询应用服务信息通过GetServiceList接口查询应用服务信息。
全链路灰度全链路灰度
DeleteSwimmingLaneGroup删除全链路泳道组调用DeleteSwimmingLaneGroup接口用于删除全链路泳道组。
DeleteSwimmingLane删除全链路泳道调用DeleteSwimmingLane接口用于删除全链路泳道。
QueryAllSwimmingLaneGroup查询所有泳道组调用QueryAllSwimmingLaneGroup接口用于查询所有泳道组。
QueryAllSwimmingLane查询当前泳道组内所有泳道调用QueryAllSwimmingLane接口用于查询当前泳道组内所有泳道。
ListAppBySwimmingLaneGroupTag获取当前泳道组内的指定标签的应用列表调用ListAppBySwimmingLaneGroupTag接口用于获取当前泳道组内的指定标签的应用列表。
GetTagsBySwimmingLaneGroupId获取当前泳道组内的所有标签调用GetTagsBySwimmingLaneGroupId接口用于获取当前泳道组内的所有标签。
QuerySwimmingLaneById通过泳道ID查询泳道信息调用QuerySwimmingLaneById接口用于通过泳道ID查询泳道信息。
Mock规则Mock规则
AddMockRule创建Mock规则调用AddMockRule接口创建Mock规则。
应用管理应用管理
CreateApplication创建应用调用CreateApplication接口创建应用。
GetOverview查询应用概览调用GetOverview接口查询应用概览信息。
K8s集群治理K8s集群治理
ModifyGovernanceKubernetesCluster更新已接入服务治理的集群信息调用ModifyGovernanceKubernetesCluster接口，修改已接入服务治理的集群信息。
GetGovernanceKubernetesCluster查询已接入服务治理的集群信息调用GetGovernanceKubernetesCluster接口，获取服务治理的kubernetes集群信息。
QueryGovernanceKubernetesCluster获取微服务治理K8s集群信息列表获取微服务治理K8s集群信息列表。
GetApplicationList获取应用列表
UpdateMessageQueueRoute更新应用消息灰度的配置调用UpdateMessageQueueRoute接口更新应用消息灰度的配置。
GetAppMessageQueueRoute获取应用消息灰度信息获取应用消息灰度相关的信息。

云原生网关

API标题API概述
域名证书域名证书
AddSSLCert添加网关域名关联证书调用AddSSLCert接口网关域名关联证书，证书可托管在云盾服务。
AddGatewayDomain添加网关关联域名调用AddGatewayDomain接口，添加网关关联域名。
DeleteGatewayDomain删除网关关联域名调用DeleteGatewayDomain接口，删除网关关联域名。
DeleteAuthResource删除网关授权资源调用DeleteAuthResource接口删除授权资源。
UpdateSSLCert更换证书调用UpdateSSLCert接口更换证书。
UpdateGatewayDomain更新关联域名信息调用UpdateGatewayDomain接口修改关联域名信息。
ListSSLCert查询网关证书列表调用ListSSLCert接口获取网关证书列表。
ListGatewayDomain查询网关已关联域名列表调用ListGatewayDomain接口，查询网关已关联域名列表。
GetGatewayDomainDetail查询网关域名详情调用GetGatewayDomainDetail接口，查询网关域名详情。
网关管理网关管理
AddGateway添加网关调用AddGateway接口添加网关。
AddGatewaySlb关联网关SLB调用AddGatewaySlb接口关联SLB。
AddSecurityGroupRule添加网关安全组规则添加网关安全组规则。
DeleteGateway删除网关信息调用DeleteGateway接口删除置指定网关。
DeleteGatewaySlb取消关联网关SLB调用DeleteGatewaySlb接口取消关联SLB。
DeleteSecurityGroupRule删除网关安全组规则删除网关安全组规则。
UpdateGatewayOption更新网关参数调用UpdateGatewayOption接口更新网关参数。
UpdateGatewayName更新网关名称调用UpdateGatewayName接口修改网关名称。
QueryGatewayRegion查询网关支持地域调用QueryGatewayRegion接口查询网关支持的地域。
QueryGatewayType查询网关可用类型调用QueryGatewayType接口查询网关可用类型。
GetGateway查询网关信息调用GetGateway接口，获取网关的所属VPC，所属交换机等基本信息。
ListGateway查询网关信息列表调用ListGateway接口查询该网关列表信息。
ListGatewaySlb查询网关入口SLB调用ListGatewaySlb接口，查询网关入口SLB。
GetGatewayOption查询网关选项调用GetGatewayOption接口获取网关全局参数。
ListSecurityGroupRule查询网关安全组列表查询网关安全组列表。
ListSecurityGroup获取安全组列表获取安全组列表。
UpdateGatewaySpec更新网关规格更新云原生网关集群节点数或规格（仅针对按量付费）。
SelectGatewaySlb查询网关SLB调用SelectGatewaySlb 接口，查询用户已有（启动中状态无监听）SLB。
服务管理服务管理
AddServiceSource创建服务来源调用AddServiceSource接口创建Nacos服务来源。
AddGatewayServiceVersion添加网关服务版本调用AddGatewayServiceVersion接口，添加服务版本。
DeleteServiceSource删除网关服务来源调用DeleteServiceSource接口，删除网关服务来源。
DeleteGatewayServiceVersion删除网关服务版本调用DeleteGatewayServiceVersion接口，删除网关服务版本。
DeleteGatewayService删除网关服务调用DeleteGatewayService删除网关服务。
UpdateGatewayServiceTrafficPolicy更新服务流量策略调用UpdateGatewayServiceTrafficPolicy接口更新服务流量策略。
UpdateGatewayServiceVersion更新服务版本调用UpdateGatewayServiceVersion接口更新修改服务。
ListServiceSource查询网关已关联的服务来源列表调用ListServiceSource接口查询已关联来源列表。
ListGatewayService查询网关已订阅的服务列表调用ListGatewayService接口，查询网关已订阅的服务列表。
GetMseSource查询MSE Nacos来源调用GetMseSource接口，查询已有MSE Nacos。
GetKubernetesSource查询ACK集群来源信息获取当前所有ACK集群来源信息。
GetGatewayServiceDetail查询网关服务详情调用GetGatewayServiceDetail接口查询服务详情。
UpdateServiceSource更新服务来源修改云原生网关服务来源，目前仅支持对含有Ingress监听配置的ACK容器服务进行修改操作。
ImportServices订阅导入网关服务调用ImportServices接口，订阅导入网关的服务。
PullServices查询所有微服务信息调用PullServices接口，查询当前来源的所有微服务。
安全能力安全能力
AddBlackWhiteList添加黑白名单调用AddBlackWhiteList接口添加黑白名单。
AddAuthResource添加鉴权资源调用AddAuthResource接口添加网关鉴权资源。
UpdateBlackWhiteList更新网关黑白名单调用UpdateBlackWhiteList接口更新网关黑白名单。
GetBlackWhiteList查询网关黑白名单调用GetBlackWhiteList接口，查询网关黑白名单。
路由配置路由配置
AddGatewayRoute添加网关路由调用AddGatewayRoute接口添加网关路由。
DeleteGatewayRoute删除网关路由调用DeleteGatewayRoute接口删除网关路由。
UpdateGatewayRouteHTTPRewrite更新网关路由的重写策略调用UpdateGatewayRouteHTTPRewrite接口更新网关路由的重写策略。
UpdateGatewayRoute更新网关路由调用UpdateGatewayRoute接口更新网关路由。
UpdateGatewayRouteCORS修改网关路由跨域策略修改网关路由跨域策略。
UpdateGatewayRouteHeaderOp修改网关路由Header设置修改网关路由Header设置。
UpdateGatewayRouteTimeout修改网关路由超时策略修改网关路由超时策略。
UpdateGatewayRouteRetry修改网关路由重试策略修改网关路由重试策略。
GetGatewayRouteDetail查询网关路由详情调用GetGatewayRouteDetail接口查询网关路由详情。
ListGatewayRoute网关路由列表调用ListGatewayRoute接口查询网关路由列表。
UpdateGatewayRouteWafStatus更新路由防护状态
ApplyGatewayRoute发布网关路由调用ApplyGatewayRoute接口发布网关路由。
OfflineGatewayRoute下线网关路由调用OfflineGatewayRoute接口下线网关路由。

其他

API标题API概述
CreateMseServiceApplication创建应用
ModifyLosslessRule修改无损规则
GetPluginConfig获取插件配置调用GetPluginConfig接口获取插件配置。
GetPlugins获取插件列表调用GetPlugins接口获取插件市场插件。
UpdatePluginConfig更新插件配置调用UpdatePluginConfig接口更新插件配置。
CreateOrUpdateSwimmingLaneGroup创建或者更新全链路灰度泳道组调用CreateOrUpdateSwimmingLaneGroup接口用于创建或者更新全链路灰度泳道组。
CreateOrUpdateSwimmingLane创建或者更新全链路灰度泳道调用CreateOrUpdateSwimmingLane接口用于创建或者更新全链路灰度泳道。
GetApplicationListWithMetircs获取应用信息列表获取应用信息列表。
阿里云首页 微服务引擎MSE 相关技术圈