On this page

Show all

Help Center/ Cloud Service Engine/ API Reference/ CSE API/ Engine Management/ Querying the Microservice Engine List

Querying the Microservice Engine List

Updated on 2023-12-18 GMT+08:00

View PDF

Function

This API is used to query the microservice engine list.

URI

GET /v2/{project_id}/enginemgr/engines

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Unique ID of a tenant's sub-project. The value contains 1 to 64 characters.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Offset.
limit	Yes	String	Number of items displayed per page.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Enterprise-Project-ID	No	String	Default enterprise project: default. Default ID: 0.
Content-Type	Yes	String	Enter application/json;charset=UTF-8.
Accept	Yes	String	Enter application/json.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of exclusive microservice engines that meet the search criteria.
data	Array of EngineSimpleInfo objects	Details about an exclusive microservice engine.

**Table 5** EngineSimpleInfo
Parameter	Type	Description
id	String	ID of an exclusive microservice engine.
name	String	Engine name.
enterpriseProjectId	String	ID of the enterprise project to which a microservice engine belongs.
enterpriseProjectName	String	Name of the enterprise project to which a microservice engine belongs.
type	String	Microservice engine type. CSE indicates an exclusive one, and CSE_Share indicates a professional one. Enumeration values: CSE CSE_Share
description	String	Description of an exclusive microservice engine.
flavor	String	Flavor of an exclusive microservice engine. Enumeration values: cse.s1.small2 cse.s1.medium2 cse.s1.large2 cse.s1.xlarge2
payment	String	Billing mode of an exclusive microservice engine. 0 indicates yearly/monthly, 1 indicates pay-per-use, and 2 indicates free of charge.
authType	String	Authentication mode of a microservice engine. RBAC indicates security authentication, and NONE indicates no authentication.
status	String	Current status of an exclusive microservice engine. Enumeration values: Creating Available Unavailable Deleting Deleted Upgrading Modifying CreateFailed DeleteFailed UpgradeFailed ModifyFailed Freezed
externalAddress	String	Address for accessing a microservice engine in a VPC on the tenant side.
serviceEndpoint	Map<String,EntrypointItem>	Address for accessing a microservice engine component in a VPC on the tenant side.
publicAddress	String	Public network access address of a microservice engine. You need to enable public network access.
publicServiceEndpoint	Map<String,EntrypointItem>	Public network access address of a microservice engine component. You need to enable public network access.
totalInstance	Integer	Total number of instances supported by a microservice engine.
usedInstance	Integer	Total number of used instances.
availableInstance	Integer	Total number of available instances.
version	String	Current version of an exclusive microservice engine.
latestVersion	String	Latest version of a microservice engine.
createTime	Long	Creation time of a microservice engine.
dueTo	Long	Expiration time of a microservice engine.
latestJobId	Integer	ID of the latest job of a microservice engine.
engineAdditionalActions	Array of strings	Additional operations allowed by a microservice engine. Enumeration values: ForceDelete Rollback Retry
specType	String	Deployment type of a microservice engine. Enumeration values: CCE CSE SpringCloud
reference	EngineReference object	Additional information about a microservice engine.

**Table 6** EntrypointItem
Parameter	Type	Description
masterEntrypoint	String	Primary IPv4 address for accessing an exclusive microservice engine component.
masterEntrypointIpv6	String	Primary IPv6 address for accessing an exclusive microservice engine component.
slaveEntrypoint	String	Secondary IPv4 address for accessing an exclusive microservice engine component.
slaveEntrypointIpv6	String	Secondary IPv4 address for accessing an exclusive microservice engine component.
type	String	Type of an exclusive microservice engine component. Enumeration values: REGISTRY SERVICE

**Table 7** EngineReference
Parameter	Type	Description
vpc	String	VPC name.
azList	Array of strings	List of AZs for microservice engine deployment.
networkId	String	Subnet network ID of a microservice engine.
subnetCidr	String	IPv4 subnet division of a microservice engine.
subnetCidrV6	String	IPv6 subnet division of a microservice engine.
subnetGateway	String	Subnet gateway of a microservice engine.
publicIpId	String	Public IP address ID of a microservice engine. You need to enable public network access.
serviceLimit	Integer	Total number of microservices supported by a package.
instanceLimit	Integer	Total number of instances supported by a package.
inputs	Map<String,String>	Additional parameter of an exclusive microservice engine.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Example Requests

GET https://{endpoint}/v2/{project_id}/enginemgr/engines

Example Responses

Status code: 200

{
  "total" : 0,
  "data" : [ {
    "id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
    "name" : "test",
    "enterpriseProjectId" : "0",
    "enterpriseProjectName" : "default",
    "type" : "CSE",
    "description" : "string",
    "flavor" : "cse.s1.medium2",
    "payment" : "0",
    "authType" : "NONE",
    "status" : "Available",
    "externalAddress" : "192.168.0.169",
    "serviceEndpoint" : {
      "kie" : {
        "masterEntrypoint" : "https://192.168.0.169:30110",
        "masterEntrypointIpv6" : "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30110",
        "slaveEntrypoint" : "string",
        "slaveEntrypointIpv6" : "string",
        "type" : "REGISTRY"
      }
    },
    "publicAddress" : "",
    "publicServiceEndpoint" : {
      "kie" : {
        "masterEntrypoint" : "",
        "masterEntrypointIpv6" : "",
        "slaveEntrypoint" : "",
        "slaveEntrypointIpv6" : "",
        "type" : "REGISTRY"
      }
    },
    "totalInstance" : 200,
    "usedInstance" : 0,
    "availableInstance" : 200,
    "version" : "2.3.1",
    "latestVersion" : "2.3.4",
    "createTime" : 1635576800332,
    "dueTo" : 4102415999000,
    "latestJobId" : 12339,
    "engineAdditionalActions" : [ "Retry" ],
    "specType" : "CSE2",
    "reference" : {
      "vpc" : "vpc-test",
      "azList" : [ "string" ],
      "networkId" : "88550801-e892-4f8e-b21b-f7147f604f69",
      "subnetCidr" : "192.168.0.0/24",
      "subnetCidrV6" : "2407:c080:11f0:11::/64",
      "subnetGateway" : "192.168.0.2",
      "publicIpId" : "",
      "serviceLimit" : 200,
      "instanceLimit" : 200,
      "inputs" : {
        "is_arm_cluster" : "true",
        "nodeFlavor" : "s6.large.2"
      }
    }
  } ]
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
500	Internal Server Error

Error Codes

See CSE Error Codes.

Parent topic: Engine Management

Previous topic: Querying Flavors Supported by a Microservice Engine

Next topic: Creating an Exclusive Microservice Engine

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot