本产品(
微服务引擎/2019-05-31
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
标签
API | 标题 | API概述 |
---|---|---|
ListTagResources | 获取标签列表 | 查标签接口。 |
UntagResources | 删除标签 | 删标签接口。 |
TagResources | 添加标签 | 为指定的资源打上标签。 |
注册配置中心
API | 标题 | API概述 |
---|---|---|
风险评估 | 风险评估 | |
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服务。 |
DeleteNacosService | 删除Nacos服务 | 删除一个Nacos服务。 |
UpdateNacosService | 更新Nacos服务 | 更新Nacos服务。 |
ListAnsServices | 查询Nacos服务详情 | 查询Nacos服务详情。 |
UpdateNacosCluster | 更新Nacos集群 | 更新Nacos集群信息。 |
ListAnsServiceClusters | 查询集群服务详情 | 查询Nacos服务的集群列表。 |
CreateNacosInstance | 创建Nacos实例 | 创建Nacos实例。 |
DeleteNacosInstance | 删除Nacos实例 | 删除Nacos服务下持久化实例。 |
UpdateNacosInstance | 更新Nacos实例信息 | 更新注册在Nacos中的实例信息。 |
ListAnsInstances | 查询Nacos服务实例列表 | 查询Nacos服务实例列表。 |
GetServiceListeners | 获取nacos服务监听者 | 获取目标服务的监听者列表。 |
Eureka服务 | Eureka服务 | |
ListEurekaServices | 查询Eureka服务列表 | 查询Eureka服务列表。 |
ListEurekaInstances | 查询Eureka实例列表 | 查询Eureka实例列表。 |
监控管理 | 监控管理 | |
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接口重试集群。 |
UpgradeCluster | 升级集群 | 升级集群版本。 |
命名空间 | 命名空间 | |
CreateEngineNamespace | 创建引擎命名空间 | 创建一个Nacos命名空间。 |
DeleteEngineNamespace | 删除引擎命名空间 | 删除Nacos命名空间。 |
UpdateEngineNamespace | 更新引擎命名空间 | 更新引擎命名空间。 |
GetEngineNamepace | 查询引擎命名空间 | 查询Nacos命名空间列表。 |
ListEngineNamespaces | 查询引擎命名空间列表 | 查询Nacos命名空间列表。 |
Zookeeper数据节点 | Zookeeper数据节点 | |
ImportZookeeperData | 发起Zookeeper数据导入 | 发起Zookeeper数据导入任务,使Zookeeper集群开始导入目标URL内的数据。 |
GetZookeeperDataImportUrl | 获取Zookeeper数据导入URL | 获取上传数据文件的URL,用户能通过此URL上传Zookeeper待导入的数据文件。 |
CreateZnode | 创建ZooKeeper数据节点 | 创建Zookeeper数据节点。 |
DeleteZnode | 删除ZooKeeper数据节点 | 释放Zookeeper数据节点。 |
UpdateZnode | 更新ZooKeeper数据节点 | 更新Zookeeper数据节点。 |
ListZnodeChildren | 查询ZooKeeper子节点 | 查询ZooKeeper数据子节点。 |
QueryZnodeDetail | 查询ZooKeeper数据节点 | 查询ZooKeeper数据节点信息。 |
ListZkTrack | 查询ZooKeeper轨迹数据 | 获取ZooKeeper的轨迹数据。 |
微服务治理中心
API | 标题 | API概述 |
---|---|---|
标签路由 | 标签路由 | |
ApplyTagPolicies | 修改标签路由规则 | 修改标签路由规则。 |
ListApplicationsWithTagRules | 获取应用的路由规则 | 通过ListApplicationsWithTagRules接口获取应用的路由规则。 |
服务查询 | 服务查询 | |
GetServiceList | 查询应用服务信息 | 通过GetServiceList接口查询应用服务信息。 |
全链路灰度 | 全链路灰度 | |
CreateOrUpdateSwimmingLaneGroup | 创建或者更新全链路灰度泳道组 | 用于创建或者更新全链路灰度泳道组。 |
DeleteSwimmingLaneGroup | 删除全链路泳道组 | 用于删除全链路泳道组。 |
CreateOrUpdateSwimmingLane | 创建或者更新全链路灰度泳道 | 用于创建或者更新全链路灰度泳道。 |
DeleteSwimmingLane | 删除全链路泳道 | 用于删除全链路泳道。 |
QueryAllSwimmingLaneGroup | 查询所有泳道组 | 用于查询所有泳道组。 |
QueryAllSwimmingLane | 查询当前泳道组内所有泳道 | 调用QueryAllSwimmingLane接口用于查询当前泳道组内所有泳道。 |
ListAppBySwimmingLaneGroupTag | 获取当前泳道组内的指定标签的应用列表 | 调用ListAppBySwimmingLaneGroupTag接口用于获取当前泳道组内的指定标签的应用列表。 |
GetTagsBySwimmingLaneGroupId | 获取当前泳道组内的所有标签 | 调用GetTagsBySwimmingLaneGroupId接口用于获取当前泳道组内的所有标签。 |
QuerySwimmingLaneById | 通过泳道ID查询泳道信息 | 调用QuerySwimmingLaneById接口用于通过泳道ID查询泳道信息。 |
Mock规则 | Mock规则 | |
AddMockRule | 创建Mock规则 | 调用AddMockRule接口创建Mock规则。 |
应用管理 | 应用管理 | |
GetApplicationList | 获取应用列表 | |
CreateMseServiceApplication | 创建应用 | 创建应用。 |
CreateApplication | 创建应用 | 调用CreateApplication接口创建应用。 |
GetOverview | 查询应用概览 | 查询应用概览信息。 |
K8s集群治理 | K8s集群治理 | |
ModifyGovernanceKubernetesCluster | 更新已接入服务治理的集群信息 | 调用ModifyGovernanceKubernetesCluster接口,修改已接入服务治理的集群信息。 |
GetGovernanceKubernetesCluster | 查询已接入服务治理的集群信息 | 调用GetGovernanceKubernetesCluster接口,获取服务治理的kubernetes集群信息。 |
QueryGovernanceKubernetesCluster | 获取微服务治理K8s集群信息列表 | 获取微服务治理K8s集群信息列表。 |
UpdateMessageQueueRoute | 更新应用消息灰度的配置 | 更新应用消息灰度的配置。 |
GetAppMessageQueueRoute | 获取应用消息灰度信息 | 获取应用消息灰度相关的信息。 |
云原生网关
API | 标题 | API概述 |
---|---|---|
插件市场 | 插件市场 | |
GetPlugins | 获取插件列表 | 获取插件市场插件。 |
GetPluginConfig | 获取插件配置 | 调用GetPluginConfig接口获取插件配置。 |
UpdatePluginConfig | 更新插件配置 | 调用UpdatePluginConfig接口更新插件配置。 |
域名证书 | 域名证书 | |
AddSSLCert | 添加网关域名关联证书 | 调用AddSSLCert接口网关域名关联证书,证书可托管在云盾服务。 |
AddGatewayDomain | 添加网关关联域名 | 调用AddGatewayDomain接口,添加网关关联域名。 |
DeleteGatewayDomain | 删除网关关联域名 | 调用DeleteGatewayDomain接口,删除网关关联域名。 |
DeleteAuthResource | 删除网关授权资源 | 调用DeleteAuthResource接口删除授权资源。 |
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 | 查询网关入口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 | 添加鉴权资源 | 添加网关鉴权资源。 |
UpdateBlackWhiteList | 更新网关黑白名单 | 调用UpdateBlackWhiteList接口更新网关黑白名单。 |
GetBlackWhiteList | 查询网关黑白名单 | 调用GetBlackWhiteList接口,查询网关黑白名单。 |
路由配置 | 路由配置 | |
AddGatewayRoute | 添加网关路由 | 添加网关路由。 |
DeleteGatewayRoute | 删除网关路由 | 调用DeleteGatewayRoute接口删除网关路由。 |
UpdateGatewayRouteHTTPRewrite | 更新网关路由的重写策略 | 调用UpdateGatewayRouteHTTPRewrite接口更新网关路由的重写策略。 |
UpdateGatewayRoute | 更新网关路由 | 调用UpdateGatewayRoute接口更新网关路由。 |
UpdateGatewayRouteCORS | 修改网关路由跨域策略 | 修改网关路由跨域策略。 |
UpdateGatewayRouteHeaderOp | 修改网关路由Header设置 | 修改网关路由Header设置。 |
UpdateGatewayRouteTimeout | 修改网关路由超时策略 | 修改网关路由超时策略。 |
UpdateGatewayRouteRetry | 修改网关路由重试策略 | 修改网关路由重试策略。 |
GetGatewayRouteDetail | 查询网关路由详情 | 调用GetGatewayRouteDetail接口查询网关路由详情。 |
ListGatewayRoute | 网关路由列表 | 调用ListGatewayRoute接口查询网关路由列表。 |
UpdateGatewayRouteWafStatus | 更新路由防护状态 | |
ApplyGatewayRoute | 发布网关路由 | 调用ApplyGatewayRoute接口发布网关路由。 |
OfflineGatewayRoute | 下线网关路由 | 调用OfflineGatewayRoute接口下线网关路由。 |
其他
API | 标题 | API概述 |
---|---|---|
ModifyLosslessRule | 修改无损规则 | 修改用户无损上下线配置。 |
GetApplicationListWithMetircs | 获取应用信息列表 | 获取应用信息列表。 |