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.

**Table 1** Overview
Type	Subtype	Description
Application management V3 APIs Use the following endpoint: servicestage.<regionname>.myhuaweicloud.com	Environment V3 APIs	APIs related to environments.
	Application V3 APIs	APIs related to applications.
	Component V3 APIs	APIs related to components.
	Runtime System V3 APIs	APIs related to runtime systems.
Application management V2 APIs Use the following endpoint: servicestage.<regionname>.myhuaweicloud.com NOTE: Application management V2 APIs are about to go offline. You are advised to use the V3 APIs.	Meta V2 APIs	APIs related to application templates, runtime systems, and application resource specifications.
	Environment V2 APIs	APIs related to application environments.
	Application V2 APIs	APIs related to applications.
	Component V2 APIs	APIs related to application components.
	Instance V2 APIs	APIs related to application component instances.
	Deployment Job V2 APIs	APIs related to deployment jobs.
Git repository access APIs Use the following endpoint: servicestage.<regionname>.myhuaweicloud.com	Git Repository Access APIs	APIs related to Git repository authorization, namespaces, projects, branches, tags, commits, hooks, repository file directories, and contents.
CSE APIs Use the following endpoint: cse.<regionname>.myhuaweicloud.com	Dynamic Configuration Engine Management	Dynamic Configuration: provides APIs related to configuration import to and export from the configuration management center. Engine Management: provides APIs related to exclusive microservice engine creation, query, and deletion.
ServiceComb-native APIs	Authentication Microservice Schema Microservice Instance Dependency Configuration Management	Authentication: provides APIs related to microservice identity authentication. Microservice: provides APIs related to microservice management. Schema: provides APIs related to microservice schema query and upload. Microservice Instance: provides APIs related to microservice instance registry and heartbeat reporting. Dependency: provides APIs related to microservice dependency query. Configuration Management: provides APIs related to configuration management of the configuration center.

Environment V3 APIs

**Table 2** Environment APIs
API	Description
Creating an Environment	Create an environment.
Obtaining All Environments	Obtain all environments.
Deleting an Environment Based on the Environment ID	Delete an environment based on the environment ID.
Modifying an Environment Based on the Environment ID	Modify an environment based on the environment ID.
Obtaining Environment Details Based on the Environment ID	Obtain environment details based on the environment ID.
Modifying an Environment Resource Based on the Environment ID	Modify an environment resource based on environment ID.
Querying an Environment Resource Based on the Environment ID	Query an environment resource based on environment ID.

Application V3 APIs

**Table 3** Application APIs
API	Description
Creating an Application	Create an application.
Obtaining All Applications	Obtain all applications.
Modifying Application Information Based on the Application ID	Modify application information based on the application ID.
Deleting an Application Based on the Application ID	Delete an application based on the application ID.
Obtaining Application Details Based on the Application ID	Obtain application details based on the application ID.
Obtaining Application Configurations Based on the Application ID	Obtain application configurations based on the application ID.
Modifying Application Configurations Based on the Application ID	Modify application configurations based on the application ID.
Deleting Application Configurations Based on the Application ID	Delete application configurations based on the application ID.

Component V3 APIs

**Table 4** Component APIs
API	Description
Creating an Application Component	Create an application component.
Obtaining All Components of an Application	Obtain all components of an application.
Obtaining All Components	Obtain all components.
Modifying Component Information by Component ID	Modify component information based on the component ID.
Deleting a Component Based on the Component ID	Delete a component based on the component ID.
Obtaining Component Information Based on the Component ID	Obtain component information based on the component ID.
Delivering Component Tasks by Component ID	Deliver a component action based on the component ID.
Obtaining Records by Component ID	Obtain records based on the component ID.

Runtime System V3 APIs

**Table 5** Runtime system APIs
API	Description
Querying a Runtime System Stack	Obtain runtime system information.

Meta V2 APIs

**Table 6** Meta APIs
API	Description
Obtaining All Supported Runtime Systems of Application Components	Obtain all supported runtime systems of application components.
Obtaining All Supported Flavors of Application Resources	Obtain all supported flavors of application resources.

Environment V2 APIs

**Table 7** Environment APIs
API	Description
Creating an Environment	Create an environment.
Obtaining All Environments	Obtain all environments.
Modifying Environment Information	Modify an environment based on the environment ID.
Deleting an Environment Based on the Environment ID	Delete an environment based on the environment ID.
Obtaining Environment Details Based on the Environment ID	Obtain environment details based on the environment ID.
Modifying Environment Resources	Modify environment resources.

Application V2 APIs

**Table 8** Application APIs
API	Description
Creating an Application	Create an application.
Obtaining All Applications	Obtain all created applications.
Modifying Application Information	Modify application information based on the application ID.
Deleting an Application Based on the Application ID	Delete an application based on the application ID.
Obtaining Application Details Based on the Application ID	Obtain application details based on the application ID.
Modifying Application Configurations	Add or modify application configurations.
Deleting Application Configurations	Delete application configurations.
Obtaining Application Configurations	Obtain application configurations.

Component V2 APIs

**Table 9** Component APIs
API	Description
Creating an Application Component	Create an application component.
Obtaining All Components of an Application	Obtain all components of an application.
Modifying Component Information Based on the Component ID	Modify component information based on the component ID.
Deleting a Component Based on the Component ID	Delete a component based on the component ID.
Obtaining Component Information Based on the Component ID	Obtain component information based on the component ID.

Instance V2 APIs

**Table 10** Instance APIs
API	Description
Creating an Application Component Instance	Create a component instance.
Obtaining All Component Instances	Obtain all instances of a component.
Querying the Operations Performed on a Component Instance	Perform operations on a component instance.
Modifying a Component Instance	Modify a component instance.
Deleting a Component Instance	Delete a component instance.
Querying Instance Details Based on the Instance ID	Obtain instance details based on the instance ID.
Obtaining Component Instance Snapshots	Obtain component instance snapshots.

Deployment Job V2 APIs

**Table 11** Deployment job API
API	Description
Obtaining Job Details	Obtain job details.

Git Repository Access APIs

**Table 12** Git repository access APIs
API	Description
Obtaining a Git Repository Authorization List	Obtain the Git repository authorization list.
Obtaining an Authorization Redirection URL	Obtain an authorization redirection URL.
Creating OAuth Authorization	Create OAuth authorization.
Creating Private Token Authorization	Create private token authorization.
Creating Password Authorization	Create password authorization for a Git repository.
Deleting Repository Authorization	Delete repository authorization based on the name.
Obtaining a Repository Namespace	Obtain namespaces of a repository.
Obtaining Repository Information Based on the Clone URL	Obtain repository information based on the clone URL.
Obtaining All Projects in a Namespace	Obtain all projects in a namespace.
Creating a Software Repository Project	Create a software repository project.
Obtaining a Project Branch	Obtain a project branch.
Obtaining a Project Tag	Obtain a project tag.
Creating a Project Tag	Create a project tag.
Deleting a Project Tag	Delete a project tag.
Obtaining Project Commits	Obtain the latest ten project commits.
Obtaining a Project Hook	Obtain a project hook.
Creating a Project Hook	Create a project hook.
Deleting a Project Hook	Delete a project hook.
Obtaining a Repository File Directory	Obtain a repository file directory.
Obtaining Repository File Contents	Obtain repository file contents.
Creating a Repository File	Create a repository file.
Modifying Repository File Contents	Modify repository file contents.
Deleting a Repository File	Delete repository file contents.

Dynamic Configuration

**Table 13** Dynamic configuration APIs
API	Description
Importing Configurations	Import configurations to the configuration management center.
Exporting Configurations	Export configurations from the configuration management center.

Engine Management

**Table 14** Engine management APIs
API	Description
Querying Flavors Supported by an Exclusive Microservice Engine	Query the flavors supported by an exclusive microservice engine.
Querying the Exclusive Microservice Engine List	Query the exclusive microservice engine list.
Creating an Exclusive Microservice Engine	Create an exclusive microservice engine.
Querying Details About an Exclusive Microservice Engine	Query details about an exclusive microservice engine.
Deleting an Exclusive Microservice Engine	Delete an exclusive microservice engine.
Querying Details About an Exclusive Microservice Engine Job	Query details about an exclusive microservice engine job.

Authentication

**Table 15** Authentication APIs
API	Description
Obtaining the User Token of an Exclusive Microservice Engine	This API is intended only for exclusive microservice engines with security authentication enabled. Before accessing APIs of an exclusive microservice engine with security authentication enabled, you need to call this API to obtain a user token. This token is the unique credential for accessing the APIs.

Microservice

**Table 16** Microservice APIs
API	Description
Querying Information About a Microservice	Query the definition information about a microservice based on serviceId.
Deleting Definition Information About a Microservice	Delete the definition and related information about a microservice, and deregisters all instances of the microservice.
Querying Information About All Microservices	Query information about microservices that meet filter criteria.
Creating Static Information for a Microservice	Create static information for a microservice before registering a microservice instance. The registered instance is associated with the static information based on the serviceId field. One service corresponds to multiple instances. The serviceId field can be customized. If serviceId is not customized, the system generates a random serviceId.
Deleting Static Information About Microservices in Batches	Delete the definitions and related information about microservices in batches, and deregisters all instances of the microservices.
Modifying Extended Attributes of a Microservice	Modify static information about a microservice To update some fields in the static information, input all static information (including the fields that do not need to be updated) in JSON format.
Querying the Unique Service or Schema ID of a Microservice	Query the unique serviceId or schema ID of a microservice based on filter criteria.

Schema

**Table 17** Schema APIs
API	Description
Querying a Microservice Schema	Query a microservice schema based on service_id and schema_id.
Modifying a Microservice Schema	Modify a microservice schema based on schema_id.
Querying All Schema Information About a Microservice	Query all schema information (including schemaId and summary) about a microservice.

Microservice Instance

**Table 18** Microservice instance APIs
API	Description
Registering a Microservice Instance	Register a microservice instance after a microservice is created. Information about the instance must be provided during registration. instanceId 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 a Microservice Instance Based on service_id	Query all instances of a microservice based on service_id after the instances are registered.
Deregistering a Microservice Instance	Deregister an instance based on instance_id after the instance is registered.
Querying Details About a Microservice Instance	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.
Modifying Status of a Microservice Instance	Modify the status of a microservice instance based on instance_id after the instance is registered.
Sending Heartbeat Information	Send heartbeat information from service provider to service center, so that the service center can check whether service instances are normal.
Querying a Microservice Instance by Filter Criteria	Query a microservice instance based on microservice version rules or field filter criteria after the instance is registered.
Querying Microservice Instances in Batches	Query microservice instances in batches based on microservice version rules or field filter criteria after the instances are registered.

Dependency

**Table 19** Dependency APIs
API	Description
Querying All Providers of a Microservice	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 services B and C based on service A ID.

Configuration Management

**Table 20** Configuration management APIs
API	Description
Creating a Configuration	Create a configuration.
Modifying a Configuration	Modify a configuration.
Querying a Configuration	Query a configuration.
Querying the Configuration List	Query the configuration list.
Deleting a Configuration	Delete a configuration.
Deleting All Configurations	Delete all configurations.