This product(
mse/2019-05-31) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Tags
| API | Title | Description |
|---|
| API | Title | Description |
|---|---|---|
| ListTagResources | ListTagResources | Queries tagged resources. |
| UntagResources | UntagResources | Untags resources. |
| TagResources | TagResources | Tags a specified resource. |
Register Configuration Center
| API | Title | Description |
|---|
| API | Title | Description |
|---|---|---|
| Migration to cloud | Migration to cloud | |
| UpdateMigrationTask | UpdateMigrationTask | Updates a migration task. |
| AddMigrationTask | AddMigrationTask | Create a new migration task |
| ListMigrationTask | ListMigrationTask | Queries information about a migration task. |
| DeleteMigrationTask | DeleteMigrationTask | Deletes a migration task. |
| Risk Assessment | Risk Assessment | |
| PutClusterHealthCheckTask | PutClusterHealthCheckTask | Initiates a task to check risk evaluation for an instance. |
| OrderClusterHealthCheckRiskNotice | OrderClusterHealthCheckRiskNotice | Subscribes to the notification feature if a risk is detected during a health check. |
| ListClusterHealthCheckTask | ListClusterHealthCheckTask | Obtains information about historical health check tasks. |
| Nacos configuration | Nacos configuration | |
| ListConfigTrack | ListConfigTrack | Obtains the track data of a Nacos configuration center. |
| CreateNacosConfig | CreateNacosConfig | Creates a Nacos configuration. |
| DeleteNacosConfig | Delete Nacos Configuration | Delete specified Nacos configuration |
| DeleteNacosConfigs | DeleteNacosConfigs | Deletes multiple Nacos configurations at a time. |
| UpdateNacosConfig | UpdateNacosConfig | Updates a Nacos configuration. |
| ListListenersByConfig | ListListenersByConfig | Queries listeners based on configuration information. |
| ListListenersByIp | ListListenersByIp | Queries the information about listeners based on IP addresses. |
| GetNacosConfig | Get Nacos Configuration | Get Nacos Configuration |
| GetNacosHistoryConfig | GetNacosHistoryConfig | Queries the historical details of Nacos configuration changes. |
| ListNacosConfigs | ListNacosConfigs | Queries Nacos configurations. |
| ListNacosHistoryConfigs | ListNacosHistoryConfigs | Queries the configuration history of a Microservices Engine (MSE) Nacos instance. |
| CloneNacosConfig | CloneNacosConfig | Copy Nacos Configuration |
| ExportNacosConfig | ExportNacosConfig | Exports specified Nacos configurations. |
| GetImportFileUrl | GetImportFileUrl | Obtains the URL that is used to upload a configuration file when you import the configuration file into a Microservices Engine (MSE) Nacos instance. |
| ImportNacosConfig | ImportNacosConfig | Imports Nacos configurations as a file. |
| Nacos service | Nacos service | |
| ListNamingTrack | ListNamingTrack | Obtains the trajectory data of a Nacos registry. |
| CreateNacosService | CreateNacosService | Creates a Nacos service. |
| ListAnsServices | ListAnsServices | Queries Nacos services. |
| DeleteNacosService | DeleteNacosService | Deletes a Nacos service. |
| UpdateNacosService | UpdateNacosService | Updates the information about a Nacos service. |
| UpdateNacosCluster | UpdateNacosCluster | Updates the information about a Nacos cluster. |
| ListAnsServiceClusters | ListAnsServiceClusters | Queries the clusters of a Nacos service. |
| CreateNacosInstance | CreateNacosInstance | Creates a Nacos instance. |
| DeleteNacosInstance | DeleteNacosInstance | Deletes a persistent application instance from a Microservices Engine (MSE) Nacos instance. |
| UpdateNacosInstance | UpdateNacosInstance | Updates the information about application instances that are registered with a Nacos instance. |
| ListAnsInstances | ListAnsInstances | Queries application instances that are registered with a Microservices Engine (MSE) Nacos instance. |
| GetServiceListeners | GetServiceListeners | Queries the list of listeners for the destination service. |
| Monitoring management | Monitoring management | |
| QueryMonitor | QueryMonitor | Queries monitoring information. |
| Whitelist management | Whitelist management | |
| UpdateAcl | UpdateAcl | Modifies an IP address whitelist. |
| Cluster management | Cluster management | |
| QueryInstancesInfo | QueryInstancesInfo | Queries the runtime data of a specified cluster. |
| QueryClusterInfo | QueryClusterInfo | Queries the static information of an instance. |
| QueryClusterDetail | QueryClusterDetail | Queries the details of an instance. |
| CreateCluster | Create Registration and Configuration Center Cluster | Create an MSE registration and configuration center instance |
| DeleteCluster | DeleteCluster | Deletes a Microservices Engine (MSE) instance. |
| UpdateCluster | UpdateCluster | Modifies the information about an instance. |
| UpdateConfig | UpdateConfig | Updates the configurations of an instance. |
| ListClusters | ListClusters | Queries Microservices Engine (MSE) instances. |
| ListClusterTypes | ListClusterTypes | Queries the engine types that can be activated. |
| ListClusterVersions | ListClusterVersions | Queries the information about supported instance versions. |
| QueryClusterSpecification | QueryClusterSpecification | Queries the information of supported instance specifications. |
| QueryClusterDiskSpecification | QueryClusterDiskSpecification | Queries disk specifications that are supported by an instance. |
| ListInstanceCount | ListInstanceCount | Displays the number of nodes that can be deployed for an instance. |
| QueryConfig | QueryConfig | Queries configuration information of an instance. |
| GetImage | GetImage | Queries the maximum version number to which the current version can be upgraded. |
| UpdateImage | UpdateImage | Updates the version number of the destination cluster. |
| GetMseFeatureSwitch | GetMseFeatureSwitch | Queries the information about the MSE feature switch. |
| QueryBusinessLocations | QueryBusinessLocations | Queries information about regions. |
| ListClusterConnectionTypes | ListClusterConnectionTypes | Queries available cluster connection types. |
| QuerySlbSpec | QuerySlbSpec | Queries the type of a Server Load Balancer (SLB) instance. |
| UpdateClusterSpec | UpdateClusterSpec | Updates the number or specifications of nodes in a pay-as-you-go Microservices Engine (MSE) instance. |
| RestartCluster | RestartCluster | Restarts a registry. |
| RetryCluster | RetryCluster | Retries a cluster. |
| Namespaces | Namespaces | |
| CreateEngineNamespace | CreateEngineNamespace | Creates a namespace in a Nacos instance. |
| DeleteEngineNamespace | DeleteEngineNamespace | Deletes a namespace from a Nacos instance. |
| UpdateEngineNamespace | UpdateEngineNamespace | Updates a namespace for the Nacos engine. |
| GetEngineNamepace | GetEngineNamepace | Queries the namespaces of a Nacos instance. |
| ListEngineNamespaces | ListEngineNamespaces | Queries the namespaces of a Nacos instance. |
| Zookeeper data node | Zookeeper data node | |
| ImportZookeeperData | ImportZookeeperData | Initiates a task to import data from a destination URL to a Microservices Engine (MSE) ZooKeeper instance. |
| GetZookeeperDataImportUrl | GetZookeeperDataImportUrl | mse-200-105 |
| ExportZookeeperData | ExportZookeeperData | Initiates a task to export ZooKeeper data. |
| ListExportZookeeperData | ListExportZookeeperData | Lists historical data export tasks of a Microservices Engine (MSE) Zookeeper instance. |
| CreateZnode | CreateZnode | Creates a znode. |
| DeleteZnode | DeleteZnode | Deletes a ZooKeeper node. |
| UpdateZnode | UpdateZnode | Updates the information about a ZooKeeper node. |
| ListZnodeChildren | ListZnodeChildren | Queries the child nodes of a ZooKeeper node. |
| QueryZnodeDetail | QueryZnodeDetail | Queries the information about a ZooKeeper node. |
| ListZkTrack | ListZkTrack | Obtains the track data of a ZooKeeper instance. |
Microservice Governance Center
| API | Title | Description |
|---|
| API | Title | Description |
|---|---|---|
| Traffic protection | Traffic protection | |
| ListSentinelBlockFallbackDefinitions | ListSentinelBlockFallbackDefinitions | Obtains the custom behavior of traffic protection. |
| BindSentinelBlockFallbackDefinition | BindSentinelBlockFallbackDefinition | Binds traffic protection behavior. |
| DeleteCircuitBreakerRules | DeleteCircuitBreakerRules | Deletes circuit breaking rules. |
| DeleteFlowRules | DeleteFlowRules | Deletes throttling rules. |
| UpdateFlowRule | UpdateFlowRule | Updates a throttling rule. |
| ListFlowRules | ListFlowRules | Obtains a list of throttling rules. |
| CreateFlowRule | CreateFlowRule | Creates a throttling rule. |
| CreateCircuitBreakerRule | CreateCircuitBreakerRule | Creates a circuit breaking rule. |
| ListCircuitBreakerRules | ListCircuitBreakerRules | Queries a list of circuit breaking rules. |
| UpdateCircuitBreakerRule | UpdateCircuitBreakerRule | Updates a circuit breaking rule. |
| Service authentication | Service authentication | |
| ListAuthPolicy | ListAuthPolicy | Queries a list of service authentication rules. |
| UpdateAuthPolicy | UpdateAuthPolicy | Updates a service authentication rule. |
| Service Inquiry | Service Inquiry | |
| GetServiceListPage | GetServiceListPage | Queries the version of a microservices application. |
| GetServiceList | GetServiceList | Queries the services of an application. |
| Full link grayscale | Full link grayscale | |
| CreateOrUpdateSwimmingLaneGroup | CreateOrUpdateSwimmingLaneGroup | Creates or updates a lane group for end-to-end canary release. |
| DeleteSwimmingLaneGroup | DeleteSwimmingLaneGroup | Deletes a lane group. |
| CreateOrUpdateSwimmingLane | CreateOrUpdateSwimmingLane | Creates or updates a lane for end-to-end canary release. |
| DeleteSwimmingLane | DeleteSwimmingLane | Deletes a lane. |
| QueryAllSwimmingLaneGroup | QueryAllSwimmingLaneGroup | Queries all lane groups. |
| QueryAllSwimmingLane | QueryAllSwimmingLane | Queries all the lanes in a lane group. |
| GetTagsBySwimmingLaneGroupId | GetTagsBySwimmingLaneGroupId | Obtains all tags in the current lane group. |
| QuerySwimmingLaneById | QuerySwimmingLaneById | Queries the information about a lane based on the lane ID. |
| ListAppBySwimmingLaneGroupTags | ListAppBySwimmingLaneGroupTags | Lists applications by tag in a specified lane group. |
| ListAppBySwimmingLaneGroupTag | ListAppBySwimmingLaneGroupTag | Queries the applications in a lane group by tag. |
| Graceful start and shutdown | Graceful start and shutdown | |
| GetLosslessRuleByApp | GetLosslessRuleByApp | Queries the rules for graceful start and shutdown of an application. |
| ModifyLosslessRule | ModifyLosslessRule | Modifies configurations of the lossless online and offline feature. |
| FetchLosslessRuleList | FetchLosslessRuleList | Obtains the rules for graceful start and shutdown. |
| Application management | Application management | |
| GetApplicationList | GetApplicationList | Obtains the list of applications. |
| CreateMseServiceApplication | CreateMseServiceApplication | Creates an application. |
| CreateApplication | CreateApplication | Creates an application. |
| GetOverview | GetOverview | Queries overview information about Microservices Governance. |
| GetApplicationInstanceList | GetApplicationInstanceList | Queries the list of microservice application instances. |
| K8s cluster governance | K8s cluster governance | |
| QueryGovernanceKubernetesCluster | QueryGovernanceKubernetesCluster | Queries the Kubernetes clusters for which Microservices Governance is activated. |
| ModifyGovernanceKubernetesCluster | ModifyGovernanceKubernetesCluster | Modifies the information about a cluster for which Microservice Governance is enabled. |
| GetGovernanceKubernetesCluster | GetGovernanceKubernetesCluster | Queries the information about a Container Service for Kubernetes (ACK) cluster for which Microservices Governance is enabled. |
| QueryNamespace | QueryNamespace | |
| Label routing | Label routing | |
| ApplyTagPolicies | ApplyTagPolicies | Modifies a tag-based routing rule. |
| ListApplicationsWithTagRules | ListApplicationsWithTagRules | Queries the routing rules of an application. |
| Canary release for messaging | Canary release for messaging | |
| GetAppMessageQueueRoute | GetAppMessageQueueRoute | Queries information about canary release for messaging of an application. |
| UpdateMessageQueueRoute | UpdateMessageQueueRoute | Updates the configuration of a canary release for messaging of an application. |
Cloud Native Gateway
| API | Title | Description |
|---|
| API | Title | Description |
|---|---|---|
| Plug-in marketplace | Plug-in marketplace | |
| GetPlugins | GetPlugins | Obtains plug-ins. |
| GetPluginConfig | GetPluginConfig | Obtains plug-in configurations. |
| CreatePluginConfig | CreatePluginConfig | Creates a plug-in configuration. |
| UpdatePluginConfig | UpdatePluginConfig | Updates plug-in configurations. |
| DeletePluginConfig | DeletePluginConfig | Deletes a plug-in configuration. |
| Domain name certificate | Domain name certificate | |
| AddSSLCert | AddSSLCert | Associates a certificate with a domain name of a gateway. You can specify a certificate that is hosted in Alibaba Cloud Security. |
| AddGatewayDomain | AddGatewayDomain | Associates a domain name with a gateway. |
| DeleteGatewayDomain | DeleteGatewayDomain | Deletes a domain name that is associated with a gateway. |
| UpdateSSLCert | UpdateSSLCert | Updates a certificate. |
| UpdateGatewayDomain | UpdateGatewayDomain | Modifies the information about the domain name associated with a gateway. |
| ListSSLCert | ListSSLCert | Obtains a list of gateway certificates. |
| ListGatewayDomain | ListGatewayDomain | Queries the domain names that are associated with a gateway. |
| GetGatewayDomainDetail | GetGatewayDomainDetail | Queries the details of a domain name associated with a gateway. |
| Gateway management | Gateway management | |
| AddGateway | AddGateway | Adds a gateway. |
| ListGatewayZone | ListGatewayZone | Obtains a list of zones where a gateway is available. |
| AddGatewaySlb | AddGatewaySlb | Associates a Server Load Balancer (SLB) instance with a gateway. |
| AddSecurityGroupRule | AddSecurityGroupRule | Creates a security group rule for a gateway. |
| DeleteGateway | DeleteGateway | Deletes a gateway. |
| DeleteGatewaySlb | DeleteGatewaySlb | Deletes the Server Load Balancer (SLB) instance that is associated with a gateway. |
| DeleteSecurityGroupRule | DeleteSecurityGroupRule | Deletes a security group rule from a gateway. |
| UpdateGatewayOption | UpdateGatewayOption | Updates the configurations of a gateway. |
| UpdateGatewayName | UpdateGatewayName | Updates the name of a gateway. |
| QueryGatewayRegion | QueryGatewayRegion | Queries the regions supported by a gateway. |
| QueryGatewayType | QueryGatewayType | Queries available gateway types. |
| GetGateway | GetGateway | Obtains the basic information about a gateway, such as the virtual private cloud (VPC) and vSwitch to which the gateway belongs. |
| ListGateway | ListGateway | Queries a list of gateways. |
| ListGatewaySlb | ListGatewaySlb | Queries the Server Load Balancer (SLB) instances that are associated with a gateway. |
| GetGatewayOption | GetGatewayOption | Obtains the global parameters of a gateway. |
| ListSecurityGroupRule | ListSecurityGroupRule | Queries the security group rules of a gateway. |
| ListSecurityGroup | ListSecurityGroup | Obtains the information about security groups. |
| UpdateGatewaySpec | UpdateGatewaySpec | Updates the number of nodes or the specifications of nodes in a pay-as-you-go or subscription cloud-native gateway. |
| SelectGatewaySlb | SelectGatewaySlb | Queries an idle Server Load Balancer (SLB) instance that is associated with a gateway. |
| Service management | Service management | |
| AddServiceSource | AddServiceSource | Adds a Nacos service source. |
| AddGatewayServiceVersion | AddGatewayServiceVersion | Adds a service version for a gateway. |
| DeleteServiceSource | DeleteServiceSource | Deletes a gateway service source. |
| DeleteGatewayServiceVersion | DeleteGatewayServiceVersion | Deletes a service version from a gateway. |
| DeleteGatewayService | DeleteGatewayService | Deletes a service from a gateway |
| UpdateGatewayServiceTrafficPolicy | UpdateGatewayServiceTrafficPolicy | Updates the traffic policy of a service. |
| UpdateGatewayServiceVersion | UpdateGatewayServiceVersion | Updates the service version of a gateway. |
| ListServiceSource | ListServiceSource | Queries a list of associated sources. |
| ListGatewayService | ListGatewayService | Queries a list of services that are subscribed to by a gateway. |
| GetMseSource | GetMseSource | Queries the existing Microservices Engine (MSE) Nacos instances that are service sources of a gateway. |
| GetKubernetesSource | GetKubernetesSource | Obtains sources of all Container Service for Kubernetes (ACK) services in a gateway. |
| GetGatewayServiceDetail | GetGatewayServiceDetail | Queries the details of a service. |
| UpdateServiceSource | UpdateServiceSource | Modifies service sources of a cloud-native gateway. You can modify only Container Service for Kubernetes (ACK) service sources that contain configurations related to Ingress resource monitoring. |
| ImportServices | ImportServices | Imports services to a gateway. |
| PullServices | PullServices | Queries all the microservices of a service source. |
| UpdateGatewayServiceCheck | UpdateGatewayServiceCheck | Updates the health check policy of a specified service in a cloud-native gateway. |
| Security capability | Security capability | |
| UpdateGatewayRouteAuth | UpdateGatewayRouteAuth | Updates the authentication configurations of a route. |
| ListGatewayAuthConsumerResource | ListGatewayAuthConsumerResource | Queries the list of authorized resources for the consumer on which a gateway performs authentication operations. |
| UpdateGatewayAuthConsumer | UpdateGatewayAuthConsumer | Updates the consumer on which a gateway performs authentication operations. |
| ListGatewayRouteOnAuth | ListGatewayRouteOnAuth | Queries a list of routes for which authentication is enabled. |
| ListGatewayAuthConsumer | ListGatewayAuthConsumer | Queries the list of consumers on which a gateway performs authentication operations. |
| UpdateGatewayAuthConsumerResource | UpdateGatewayAuthConsumerResource | Updates a list of resources on which permissions are granted to a gateway authentication consumer. |
| UpdateGatewayAuthConsumerStatus | UpdateGatewayAuthConsumerStatus | Updates the status of the consumer on which a gateway performs authentication operations. |
| AddGatewayAuthConsumer | AddGatewayAuthConsumer | Adds a consumer on which a gateway performs authentication operations. |
| DeleteGatewayAuthConsumerResource | DeleteGatewayAuthConsumerResource | Deletes resource permissions from the consumer on which a gateway performs authentication operations. |
| UpdateGatewayAuthConsumerResourceStatus | UpdateGatewayAuthConsumerResourceStatus | Updates the resource authorization status for the consumer on which a gateway performs authentication operations. |
| DeleteGatewayAuthConsumer | DeleteGatewayAuthConsumer | Deletes a consumer on which a gateway performs authentication operations. |
| GetGatewayAuthConsumerDetail | GetGatewayAuthConsumerDetail | Queries the details of the consumer on which a gateway performs authentication operations. |
| AddBlackWhiteList | AddBlackWhiteList | Creates a blacklist or a whitelist. |
| UpdateBlackWhiteList | UpdateBlackWhiteList | Modifies the blacklist or whitelist of a gateway. |
| GatewayBlackWhiteList | GatewayBlackWhiteList | Queries a list of blacklists and whitelists of a gateway. |
| GetBlackWhiteList | GetBlackWhiteList | Queries the blacklist or whitelist of a gateway. |
| AddGatewayAuth | AddGatewayAuth | Adds an authentication configuration for a gateway. |
| AddAuthResource | AddAuthResource | Adds authorization information for a gateway. |
| DeleteAuthResource | DeleteAuthResource | Deletes an authorized resource. |
| Routing configuration | Routing configuration | |
| AddGatewayRoute | AddGatewayRoute | Adds a gateway route. |
| DeleteGatewayRoute | DeleteGatewayRoute | Deletes a route from a gateway. |
| UpdateGatewayRouteHTTPRewrite | UpdateGatewayRouteHTTPRewrite | Updates the rewrite policy of a route for a gateway. |
| UpdateGatewayRoute | UpdateGatewayRoute | Updates a route for a gateway. |
| UpdateGatewayRouteCORS | UpdateGatewayRouteCORS | Modifies the cross-origin resource sharing (CORS) policy of a route. |
| UpdateGatewayRouteHeaderOp | UpdateGatewayRouteHeaderOp | Modifies the header configuration policy of a route. |
| UpdateGatewayRouteTimeout | UpdateGatewayRouteTimeout | Modifies the timeout policy of a route. |
| UpdateGatewayRouteRetry | UpdateGatewayRouteRetry | Modifies the retry policy of a route. |
| GetGatewayRouteDetail | GetGatewayRouteDetail | Queries the details of a route for a gateway. |
| ListGatewayRoute | ListGatewayRoute | Queries the routes of a gateway. |
| UpdateGatewayRouteWafStatus | UpdateGatewayRouteWafStatus | Updates the WAF status of a route. |
| ApplyGatewayRoute | ApplyGatewayRoute | Publishes a route for a gateway. |
| OfflineGatewayRoute | OfflineGatewayRoute | Disables a route for a gateway. |
| Parameter configuration | Parameter configuration | |
| EnableProxyProtocol | EnableProxyProtocol | Enables the proxy protocol. When an NLB instance is used as an ingress, you cannot obtain the real IP address of the client if you do not enable the proxy protocol. After you enable the proxy protocol, non-proxy requests are not adversely affected. |
| EnableHttp2 | EnableHttp2 | Enables HTTP/2 for negotiation between the server and client. The modification takes effect in one to two minutes. |
| PreserveHeaderFormat | PreserveHeaderFormat | Specifies whether to convert all letters of a header into lowercase letters. For requests and responses, HTTP/1.1 headers are not case-sensitive. By default, all letters of headers are converted into lowercase letters. |
| Strategy configuration | Strategy configuration | |
| CreateGatewayFlowRule | CreateGatewayFlowRule | Creates a throttling rule for a gateway. |
Others
| API | Title | Description |
|---|
| API | Title | Description |
|---|---|---|
| CloneSentinelRuleFromAhas | CloneSentinelRuleFromAhas | Clones rules from Application High Availability Service. |
| ChangeResourceGroup | Change the Resource Group of an Instance | Resource Transfer |
