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

Use the following endpoint:

servicestage.<regionname>.myhuaweicloud.com

Mate 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.

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.

Cloud Service Engine (CSE) APIs

Use the following endpoint:

cse.<regionname>.myhuaweicloud.com

Microservice APIs

APIs related to microservices.

Schema APIs

APIs related to schemas.

Dependency APIs

APIs related to dependencies.

Microservice Instance APIs

APIs related to microservice instances.

Dynamic Configuration APIs

APIs related to dynamic configuration.

Dashboard APIs

APIs related to dashboards.

Mate APIs

Table 2 Mate APIs

API

Description

Obtaining All Supported Templates of Application Components

Obtain all supported built-in templates of application components.

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.

Modifying Application Configurations

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.

Performing Operations on a Component Instance

Query the operations performed 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.

Git Repository Access APIs

Table 8 Git repository access APIs

API

Description

Obtaining a Git Repository Authorization List

Obtain a 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 a repository namespace.

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 a repository file.

Microservice APIs

Table 9 Microservice APIs

API

Description

Querying Information About a Microservice

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.

Querying Information About 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 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.

Querying the Unique Service or Schema ID of a Microservice

Query the unique service or schema ID of a microservice based on filter criteria.

Schema APIs

Table 10 Schema APIs

API

Description

Querying the Schema Information About a Microservice

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 schema_id and summary) about a microservice.

Dependency APIs

Table 11 Dependency APIs

API

Description

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 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

Table 12 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. 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.

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.

Changing the Status of a Microservice Instance

Change the status of a microservice instance based on instance_id after the instance is registered.

Sending Heartbeat Messages

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 Microservice Instances in Batches

Query microservice instances in batches based on microservice version rules or field filter criteria after the instances are registered.

Dynamic Configuration APIs

Table 13

API

Description

Querying Configurations in the Configuration Center

Query configurations in the configuration center.

Dashboard APIs

Table 14

API

Description

Reporting Service Metrics

Report service metrics to the dashboard.