API Overview
ServiceStage provides open APIs for developers and partners to develop, deploy, host, operate, and manage applications, helping them effectively innovate services at low costs and shorten the application rollout period.
For details about the APIs, see the following table.
| Type | Subtype | Description |
|---|---|---|
| Application management APIs Use the following endpoint: servicestage.<regionname>.myhuaweicloud.com | APIs related to application templates, runtimes, and application resource specifications. | |
| APIs related to application environments. | ||
| APIs related to applications. | ||
| APIs related to application components. | ||
| APIs related to application component instances. | ||
| APIs related to jobs. | ||
| Git repository access APIs Use the following endpoint: servicestage.<regionname>.myhuaweicloud.com | APIs related to Git repository authorization, namespaces, projects, branches, tags, commits, hooks, repository file directories, and contents. | |
| Cloud Service Engine (CSE) APIs Use the following endpoint: cse.<regionname>.myhuaweicloud.com | APIs related to microservices. | |
| APIs related to schemas. | ||
| APIs related to dependencies. | ||
| APIs related to microservice instances. | ||
| APIs related to dynamic configuration. | ||
| APIs related to dashboards. |
Mate APIs
| API | Description |
|---|---|
| Obtain all supported built-in templates of application components. | |
| Obtain all supported runtimes of application components. | |
| Obtain all supported flavors of application resources. |
Environment APIs
| API | Description |
|---|---|
| Create an environment. | |
| Obtain all created environments. | |
| Modify environment information based on the environment ID. | |
| Delete an environment based on the environment ID. | |
| Obtain environment details based on the environment ID. | |
| Modify environment resources. |
Application APIs
| API | Description |
|---|---|
| Create an application. | |
| Obtain all created applications. | |
| Modify application information based on the application ID. | |
| Delete an application based on the application ID. | |
| Obtain application details based on the application ID. | |
| Modify application configurations. | |
| Delete application configurations. | |
| Obtain application configurations. |
Component APIs
| API | Description |
|---|---|
| Create an application component. | |
| Obtain all components of an application. | |
| Modify component information based on the component ID. | |
| Delete a component based on the component ID. | |
| Obtaining Application Component Information Based on the Component ID | Obtain component information based on the component ID. |
Instance APIs
| API | Description |
|---|---|
| Create an application component instance. | |
| Obtain all instances of a component. | |
| Query the operations performed on a component instance. | |
| Modify an application component instance. | |
| Delete an application component instance. | |
| Query instance details based on the instance ID. | |
| Obtain component instance snapshots. |
Git Repository Access APIs
| API | Description |
|---|---|
| Obtain a Git repository authorization list. | |
| Obtain an authorization redirection URL. | |
| Create OAuth authorization. | |
| Create private token authorization. | |
| Create password authorization for a Git repository. | |
| Delete repository authorization based on the name. | |
| Obtain a repository namespace. | |
| Obtain repository information based on the clone URL. | |
| Obtain all projects in a namespace. | |
| Create a software repository project. | |
| Obtain a project branch. | |
| Obtain a project tag. | |
| Create a project tag. | |
| Delete a project tag. | |
| Obtain the latest ten project commits. | |
| Obtain a project hook. | |
| Create a project hook. | |
| Delete a project hook. | |
| Obtain a repository file directory. | |
| Obtain repository file contents. | |
| Create a repository file. | |
| Modify repository file contents. | |
| Delete a repository file. |
Microservice APIs
| API | Description |
|---|---|
| Query information about a microservice based on service_id. | |
| Deleting Definition and Related Information About a Microservice | Delete the definition and related information about a microservice, and deregister all instances of the microservice. |
| Query information about microservices that meet filter criteria. | |
| Create static information for a microservice before registering a microservice instance. The registered instance is associated with the static information based on service_id. One service corresponds to multiple instances. service_id can be customized. If service_id is not customized, the system generates a random service ID. | |
| Deleting Definitions and Related Information About Microservices in Batches | Delete the definitions and related information about microservices in batches, and deregister all instances of the microservices. |
| Modifying Extended Attribute Information About a Microservice | Modify static information about a microservice. To update some fields in the static information, you need to input all static information (including the fields that do not need to be updated) in JSON format. |
| Query the unique service or schema ID of a microservice based on filter criteria. |
Schema APIs
| API | Description |
|---|---|
| Query a microservice schema based on service_id and schema_id. | |
| Modify a microservice schema based on schema_id. | |
| Query all schema information (including schema_id and summary) about a microservice. |
Dependency APIs
| API | Description |
|---|---|
| Create a dependency between services. For consumer, version must be a confirmed version and serviceName cannot be *. consumer must be an existing service while provider can be a service that has not been created. | |
| Query all providers of a microservice based on consumer_id. For example, if service A depends on services B and C, you can query the information about the services B and C based on the service A's ID. |
Microservice Instance APIs
| API | Description |
|---|---|
| Register a microservice instance after a microservice is created. Information about the instance must be provided during registration. instance_id can be customized. If it is customized, all contents are overwritten upon re-registration. If it is not customized, the system automatically generates an ID. If the endpoint content is duplicate, the original ID is used. | |
| Querying Instances of a Microservice Based on the Service ID | Query all instances of a microservice based on service_id after the instances are registered. |
| Deregister an instance based on instance_id after the instance is registered. | |
| Query details about an instance based on service_id and instance_id after the instance is registered. | |
| Modifying the Extended Information About a Microservice Instance | Add or update the extended information about a microservice instance based on instance_id after the instance is registered. |
| Change the status of a microservice instance based on instance_id after the instance is registered. | |
| Send heartbeat information. Service providers need to send heartbeat information to the service center, so that the center can check whether service instances are normal. | |
| Query a microservice instance based on microservice version rules or field filter criteria after the instance is registered. | |
| Query microservice instances in batches based on microservice version rules or field filter criteria after the instances are registered. |
Dynamic Configuration APIs
| API | Description |
|---|---|
| Query configurations in the configuration center. |
Last Article: Concepts
Next Article: Calling APIs
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.