Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
Huawei Cloud Astro Canvas
Huawei Cloud Astro Zero
CodeArts Governance
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance (CCI)
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Cloud Transformation
Well-Architected Framework
Cloud Adoption Framework
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Blockchain
Blockchain Service
Web3 Node Engine Service
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Cloud Service Engine/ API Reference/ CSE API/ Engine Management/ Querying Microservice Engine Details

Querying Microservice Engine Details

Updated on 2025-04-25 GMT+08:00

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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback