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 APIs	Meta APIs	APIs related to application templates, runtimes, and application resource specifications.
	Environment APIs	APIs related to application environments.
	Application APIs	APIs related to applications.
	Component APIs	APIs related to application components.
	Instance APIs	APIs related to application component instances.
	Job APIs	APIs related to jobs.
Cloud Service Engine (CSE) APIs	CSE APIs	APIs related to CSE.

Meta APIs

**Table 2** Meta APIs
API	Description
Obtaining All Supported Runtimes of Application Components	Obtain all supported runtimes of application components.
Obtaining All Supported Flavors of Application Resources	Obtain all supported flavors of application resources.

Environment APIs

**Table 3** Environment APIs
API	Description
Creating an Environment	Create an environment.
Obtaining All Environments	Obtain all created environments.
Modifying Environment Information	Modify environment information 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 APIs

**Table 4** 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.
Adding or Modifying Application Configurations	Add or modify application configurations.
Deleting Application Configurations	Delete application configurations.
Obtaining Application Configurations	Obtain application configurations.

Component APIs

**Table 5** 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 an Application Component 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

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

Job APIs

**Table 7** Job APIs
API	Description
Obtaining Job Details	Obtain job details.

CSE APIs

**Table 8** CSE APIs
API	Description
Querying Static Information About a Microservice	Query static information about a microservice based on the service ID.
Querying Static Information About All Microservices	Query static 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 service ID.
Modifying Static 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.
Querying a Microservice Schema	Query a microservice schema based on the service ID and schema ID.
Modifying a Microservice Schema	Modify a microservice schema based on the schema ID.
Creating a Dependency Between Services	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.
Querying All Providers of a Microservice	Query all providers of a microservice based on the consumer ID.
Querying the Unique Service or Schema ID of a Microservice	Query the unique service or schema ID of a microservice based on filter criteria.
Registering a Microservice Instance	Register a microservice instance after a microservice is created. Information about the instance must be provided during registration. The 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 All Instances of a Microservice Based on the Service ID	Query all instances of a microservice based on the service ID after the instances are registered.
Deregistering a Microservice Instance	Deregister an instance based on the instance ID after the instance is registered.
Querying Details About a Microservice Instance	Query details about an instance based on the 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 the instance ID after the instance is registered.
Changing the Status of a Microservice Instance	Change the status of a microservice instance based on the instance ID after the instance is registered.
Sending Heartbeat Information	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.
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 Configurations	Query configurations in the configuration center.
Deleting Static Information About a Microservice	Delete the definition and related information about a microservice, and deregister all instances of the microservice.
Deleting Static Information About Microservices in Batches	Delete the definitions and related information about microservices in batches, and deregister all instances of the microservices.
Querying Microservice Instances in Batches	Query microservice instances in batches based on microservice version rules or field filter criteria after the instances are registered.
Querying All Schema Information About a Microservice	Query all schema information (including schemaId and summary) about a microservice.