Help Center/ Cloud Service Engine/ API Reference/ CSE API/ Engine Management/ Querying Microservice Engine Details
Updated on 2025-04-25 GMT+08:00

Querying Microservice Engine Details

Function

This API is used to query microservice engine details.

URI

GET /v2/{project_id}/enginemgr/engines/{engine_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which must be unique. The value contains 1 to 64 characters.

engine_id

Yes

String

Microservice engine ID.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Enterprise-Project-ID

No

String

If this parameter is not set, the default enterprise project is default and the ID is 0.

Content-Type

Yes

String

Set it to application/json;charset=UTF-8.

Accept

Yes

String

Set it to application/json.

Response

Status code: 200
Table 3 Response body parameters

Parameter

Type

Description

id

String

Microservice engine ID.

name

String

Microservice engine name.

description

String

Microservice engine description.

authType

String

Authentication type of a microservice engine.

Enumerated values:

  • RBAC
  • NONE

flavor

String

Microservice engine flavor.

payment

String

Billing mode of a microservice engine.

version

String

Current version of a microservice engine.

latestVersion

String

Latest version of a microservice engine.

status

String

Status of a microservice engine.

Enumerated values:

  • Creating
  • Available
  • Unavailable
  • Deleting
  • Deleted
  • Upgrading
  • Modifying
  • CreateFailed
  • DeleteFailed
  • UpgradeFailed
  • ModifyFailed
  • Freezed

beDefault

Boolean

Whether the engine is the default engine.

createUser

String

Creator of a microservice engine.

createTime

Long

Creation time of a microservice engine.

cceSpec

Spec object

Application specifications of a microservice engine.

externalEntrypoint

EngineExternalEntrypoint object

External node address of a microservice engine.

reference

EngineReference object

Parameters about a microservice engine.

latestJobId

Integer

ID of the latest job of a microservice engine.

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.

engineAdditionalActions

Array of strings

Additional operations allowed by a microservice engine.

Enumerated values:

  • ForceDelete
  • Rollback
  • Retry

specType

String

Deployment type of a microservice engine.

Default value: CSE

Enumerated values:

  • CCE
  • CSE
  • SpringCloud

type

String

Microservice engine type.

  • CSE: exclusive ServiceComb engine.
  • NACOS: registry/configuration center.

Enumerated values:

  • CSE
  • NACOS

projectId

String

ID of the project to which an exclusive microservice engine belongs.

vmIds

Array of strings

ID list of VMs used by the current engine on the resource tenant side

Table 4 Spec

Parameter

Type

Description

id

Long

CCE specification ID of a microservice engine.

engineId

String

Microservice engine ID.

specType

String

CCE cluster deployment type of a microservice engine.

Enumerated values:

  • CCE
  • CSE
  • SpringCloud

cluster

String

CCE cluster information about a microservice engine. Currently, the value is null.

clusterId

String

CCE cluster ID of a microservice engine.

clusterNodes

SpecClusterNode object

CCE node list of an exclusive microservice engine.

flavor

String

CCE cluster flavor of a microservice engine.

region

String

Region where the CCE cluster of a microservice engine is located.

version

String

CCE cluster version of a microservice engine.

extendParam

String

Additional parameter of the CCE cluster of a microservice engine.

Table 5 SpecClusterNode

Parameter

Type

Description

clusterNodes

Array of ClusterNode objects

CCE node information.

Table 6 ClusterNode

Parameter

Type

Description

id

String

CCE node ID of an exclusive microservice engine.

az

String

AZ to which the CCE cluster of an exclusive microservice engine belongs.

ip

String

CCE node IP of an exclusive microservice engine.

label

String

CCE node label of an exclusive microservice engine.

status

String

CCE node label of an exclusive microservice engine.

Default value: Active

Table 7 EngineExternalEntrypoint

Parameter

Type

Description

externalAddress

String

External IP address of an exclusive microservice engine.

publicAddress

String

Public network address of an exclusive microservice engine.

serviceEndpoint

Map<String,EntrypointItem>

Address for accessing an exclusive microservice engine component.

publicServiceEndpoint

Map<String,EntrypointItem>

Public network address of an exclusive microservice engine component.

Table 8 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 IPv6 address for accessing an exclusive microservice engine component.

type

String

Type of an exclusive microservice engine component.

Enumerated values:

  • REGISTRY
  • SERVICE
Table 9 EngineReference

Parameter

Type

Description

vpc

String

VPC name.

azList

Array of strings

AZ list of a microservice engine.

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 network address ID of a microservice engine.

serviceLimit

String

Total number of microservices supported by a microservice engine.

instanceLimit

String

Total number of instances supported by a microservice engine.

inputs

Map<String,String>

Additional parameter of a microservice engine.

Status code: 400
Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

detail

String

Location details.

Status code: 500
Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

detail

String

Location details.

Example Request

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

Example Response

Status code: 200

Response structure for querying microservice engine details.

{
  "id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
  "name" : "test",
  "description" : "string",
  "authType" : "NONE",
  "flavor" : "cse.s1.medium2",
  "payment" : "0",
  "version" : "2.3.1",
  "latestVersion" : "2.3.4",
  "status" : "Creating",
  "beDefault" : true,
  "createUser" : "string",
  "createTime" : 1635576800332,
  "cceSpec" : {
    "id" : 7465,
    "engineId" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
    "specType" : "CCE",
    "cluster" : "",
    "clusterId" : "41115a6f-912f-11eb-9af9-0255ac100188",
    "clusterNodes" : {
      "clusterNodes" : [ {
        "id" : "c13aaf5c-2192-421c-8e03-522e2b9a06b5",
        "az" : "test",
        "ip" : "172.31.25.277",
        "label" : "test",
        "status" : "Active"
      } ]
    },
    "flavor" : "string",
    "region" : "test",
    "version" : "",
    "extendParam" : ""
  },
  "externalEntrypoint" : {
    "externalAddress" : "192.168.0.169",
    "publicAddress" : "",
    "serviceEndpoint" : {
      "serviceCenter" : {
        "masterEntrypoint" : "https://192.168.0.169:30110",
        "masterEntrypointIpv6" : "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30110",
        "slaveEntrypoint" : "",
        "slaveEntrypointIpv6" : "",
        "type" : "REGISTRY"
      }
    },
    "publicServiceEndpoint" : {
      "serviceCenter" : {
        "masterEntrypoint" : "",
        "masterEntrypointIpv6" : "",
        "slaveEntrypoint" : "",
        "slaveEntrypointIpv6" : "",
        "type" : "REGISTRY"
      }
    }
  },
  "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" : {
      "nodeFlavor" : "s6.large.2",
      "is_arm_cluster" : "false"
    }
  },
  "latestJobId" : 12339,
  "enterpriseProjectId" : "0",
  "enterpriseProjectName" : "default",
  "engineAdditionalActions" : [ "Noting" ],
  "specType" : "CSE2",
  "type" : "CSE",
  "projectId" : "string",
  "vmIds" : [ ]
}

Status Code

Status Code

Description

200

OK

400

Bad Request

500

Internal Server Error

Error Code

See Error Codes.