Help Center/ ServiceStage/ API Reference/ CSE APIs/ Engine Management/ Querying the Microservice Engine List
Updated on 2025-09-25 GMT+08:00

Querying the Microservice Engine List

Function

This API is used to query the microservice engine list.

URI

GET /v2/{project_id}/enginemgr/engines

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant sub-project ID, which must be unique. The value contains 1 to 64 characters. See Obtaining a Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset.

limit

No

Integer

Number of data records on each page.

type

No

String

Engine type: CSE or CSE_SHARE.

Request

Table 3 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of microservice engines.

data

Array of EngineInfo objects

Microservice engine details.

Table 5 EngineInfo

Parameter

Type

Description

id

String

Microservice engine ID.

name

String

Microservice 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

Engine type: CSE or CSE_SHARE.

description

String

Microservice engine description.

flavor

String

Microservice engine flavor.

payment

String

Billing mode of a microservice engine. 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 a microservice engine.

externalAddress

String

Address for accessing a microservice engine in a VPC on the tenant side.

serviceEndpoint

Object

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

Object

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 a microservice engine.

latestVersion

String

Latest version of a microservice engine.

createTime

Integer

Creation time of a microservice engine.

dueTo

Integer

Expiration time of a microservice engine.

latestJobId

Integer

ID of the latest job of a microservice engine.

engineAdditionalActions

Array of String

Additional operations allowed by a microservice engine.

Delete

ForceDelete

Upgrade

Retry

Configure

specType

String

Deployment type of an exclusive microservice engine.

  • For the 1.x engine, the value is fixed to CSE.
  • For the 2.x engine, the value is fixed to CSE2.

reference

Object

Additional information about a microservice engine.

Table 6 Endpoint

Parameter

Type

Description

kie

Object

Endpoint information of the configuration center.

serviceCenter

Object

Endpoint information of the service center.

Table 7 EntryPoint

Parameter

Type

Description

masterEntrypoint

String

Primary IPv4 address for accessing a microservice engine component in a VPC.

masterEntrypointIpv6

String

Primary IPv6 address for accessing a microservice engine component in a VPC.

slaveEntrypoint

String

Secondary IPv4 address for accessing a microservice engine component in a VPC.

slaveEntrypointIpv6

String

Secondary IPv6 address for accessing a microservice engine component in a VPC.

type

String

Type of an exclusive microservice engine component.

CSE

Table 8 EngineReference

Parameter

Type

Description

vpc

String

VPC name.

vpcId

String

VPC ID. The value can contain up to 64 characters.

azList

Array of String

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 a microservice engine.

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

errorCode

String

Error code.

errorMessage

String

Error message.

detail

String

Location details.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

errorCode

String

Error code.

errorMessage

String

Error message.

detail

String

Location details.

Example Request

Query the microservice engine list.

GET /v2/{project_id}/enginemgr/engines

Example Response

{
	"total": 1,
	"data": [{
		"id": "891bf21a-4024-4f47-b38c-bd259ca8f10a",
		"name": "test",
		"enterpriseProjectId": "0",
		"enterpriseProjectName": "default",
		"type": "CSE_SHARE",
		"description": "",
		"flavor": "cse.s1.medium2",
		"payment": "0",
		"authType": "RBAC",
		"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": null,
				"slaveEntrypointIpv6": null,
				"type": "REGISTRY"
			},
                       "serviceCenter": {
                                "masterEntrypoint": "https://192.168.0.169:30100",
                                "masterEntrypointIpv6": "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30100",
                                "slaveEntrypoint": null,
                                "slaveEntrypointIpv6": null,
                                "type": "REGISTRY"
                        }
		},
		"publicAddress": "",
		"publicServiceEndpoint": {
			"kie": {
				"masterEntrypoint": "",
				"masterEntrypointIpv6": "",
				"slaveEntrypoint": "",
				"slaveEntrypointIpv6": "",
				"type": "REGISTRY"
			},
                       "serviceCenter": {
                                "masterEntrypoint": "",
                                "masterEntrypointIpv6": "",
                                "slaveEntrypoint": "",
                                "slaveEntrypointIpv6": "",
                                "type": "REGISTRY"
                        }
		},
		"totalInstance": 200,
		"usedInstance": 0,
		"availableInstance": 200,
		"version": "2.3.1",
		"latestVersion": "2.3.3",
		"createTime": 1635576800332,
		"dueTo": 4102415999000,
		"latestJobId": 12339,
		"engineAdditionalActions": ["Retry"],
		"specType": "CSE2",
		"reference": {
			"vpc": "vpc-test",
                        "vpcId": "09902850-9454-4715-9764-018f0c3701hy",
			"azList": ["test"],
			"networkId": "88550801-e892-4f8e-b21b-f7147f604f69",
			"subnetCidr": "192.168.0.0/24",
			"subnetCidrV6": "2407:c080:11f0:11::/64",
			"subnetGateway": "192.168.0.2",
			"publicIpId": null,
			"serviceLimit": 200,
			"instanceLimit": 200,
			"inputs": {
				"is_arm_cluster": "false",
				"nodeFlavor": "s6.large.2"
			}
		}
	}]
}

Status Code

Status Code

Description

200

OK

400

Bad Request

500

Internal Server Error

Error Code

See CSE Error Codes.