文档首页/应用管理与运维平台 ServiceStage/API参考/CSE API/引擎管理/查询微服务引擎详情 - QueryDetailsAboutMicroserviceEngine
更新时间：2026-02-28 GMT+08:00
查看PDF
分享

查询微服务引擎详情 - QueryDetailsAboutMicroserviceEngine

功能介绍

查询微服务引擎详情。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户子项目的唯一标识，字符长度为1~64位，获取方法请参考获取项目ID。

engine_id

是

String

微服务引擎ID，获取方法请参考查询微服务引擎列表。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

X-Enterprise-Project-ID

否

String

企业项目ID。

如果不配置此参数，则默认企业项目为“default”，ID为0。

响应参数

状态码： 200

表3 响应Body体

参数

参数类型

描述

id

String

微服务引擎ID。

name

String

微服务引擎名称。

projectId

String

微服务引擎所属项目ID。

enterpriseProjectId

String

微服务引擎所属企业项目ID。

enterpriseProjectName

String

微服务引擎所属企业项目名称。

type

String

引擎的类型。

取值范围：

  • CSE：微服务引擎专享版。
  • CSE_SHARE：微服务引擎共享版。

description

String

微服务引擎描述。

beDefault

Boolean

微服务引擎是否是默认引擎。

flavor

String

微服务引擎专享版规格。

取值范围：

  • cse.s1.small2：高可用100实例引擎。
  • cse.s1.medium2：高可用200实例引擎。
  • cse.s1.large2：高可用500实例引擎。
  • cse.s1.xlarge2：高可用2000实例引擎。

payment

String

微服务引擎计费方式。

取值范围：

  • 0：表示包周期
  • 1：表示按需
  • 2：表示免费

authType

String

微服务引擎认证方式。

取值范围：

  • RBAC：为引擎开启安全认证。
  • NONE：为引擎未开启安全认证。

authConfig

表4

微服务引擎的RBAC设置信息。

status

String

微服务引擎当前状态。

取值范围：

  • Creating：创建中
  • Available：可用
  • Unavailable：不可用
  • Deleting：删除中
  • Deleted：已删除
  • Upgrading：升级中
  • Modifying：变更中
  • CreateFailed：创建失败
  • DeleteFailed：删除失败
  • UpgradeFailed：升级失败
  • ModifyFailed：变更失败
  • Freezed：已冻结

cceSpec

Object

微服务引擎CCE规格。

externalEntrypoint

Object

微服务引擎接入地址。

publicAddress

String

微服务引擎公网访问地址，需要开启公网访问。

version

String

微服务引擎当前版本。

latestVersion

String

微服务引擎最新版本。

createTime

Integer

微服务引擎创建时间。

createUser

String

微服务引擎创建者。

latestJobId

Integer

微服务引擎最近的任务ID。

engineAdditionalActions

Array of strings

微服务引擎允许的附加操作。

取值范围：

  • Delete：删除。
  • ForceDelete：强制删除。
  • Upgrade：升级。
  • Retry：重试。

specType

String

微服务引擎专享版部署类型。

取值范围：

  • 1.x引擎时，固定值CSE。
  • 2.x引擎时，固定值为CSE2。

reference

Object

微服务引擎附加信息。

vmIds

Array of strings

当前微服务引擎在资源租户侧使用的虚拟机ID列表。

表4 authConfig

参数

参数类型

描述

consoleAuthEnabled

Boolean

是否开启控制台安全认证。

sdkAuthEnabled

Boolean

是否开启编程接口安全认证。

表5 EngineReference

参数

参数类型

描述

vpc

String

vpc名称。

vpcId

String

vpc的id，长度不超过64位。

azList

Array of strings

微服务引擎部署可用区列表。

networkId

String

微服务引擎子网网络ID。

subnetCidr

String

微服务引擎ipv4子网划分。

subnetCidrV6

String

微服务引擎ipv6子网划分。

subnetGateway

String

微服务引擎子网网关。

publicIpId

String

微服务引擎公网地址ID，需要开启公网访问。

serviceLimit

Integer

套餐可支持的微服务总数。

instanceLimit

Integer

套餐可支持的实例总数。

inputs

Map <String,String>

微服务引擎附加参数。

表6 Spec

参数

参数类型

描述

id

Integer

微服务引擎CCE规格ID。

engineId

String

微服务引擎ID。

specType

String

微服务引擎CCE集群部署类型。取值为CCE。

cluster

String

微服务引擎CCE集群信息，目前为null。

clusterId

String

微服务引擎CCE集群ID。

clusterNodes

Object

微服务引擎CCE节点列表。

flavor

String

微服务引擎CCE集群规格。

region

String

微服务引擎CCE集群所在局点。

version

String

微服务引擎CCE集群版本。

extendParam

String

微服务引擎CCE集群附加参数。

表7 SpecClusterNode

参数

参数类型

描述

clusterNodes

Array of ClusterNode objects

微服务引擎CCE节点信息。

表8 ClusterNode

参数

参数类型

描述

id

String

微服务引擎CCE节点ID。

az

String

微服务引擎CCE节点所属可用区。

ip

String

微服务引擎CCE节点IP。

label

String

微服务引擎CCE节点标签。

status

String

微服务引擎CCE节点状态。

取值范围：

  • Build：创建中，表示节点正处于创建过程中。
  • Installing：安装中，表示节点正处于纳管过程中。
  • Upgrading：升级中，表示节点正处于升级过程中。
  • Active：运行中，表示节点处于正常状态。
  • Abnormal：不可用，表示节点处于异常状态。
  • Deleting： 删除中，表示节点正处于删除过程中。
  • Error：错误，表示节点处于故障状态。
表9 EngineExternalEntrypoint

参数

参数类型

描述

externalAddress

String

微服务引擎租户侧VPC内访问地址。

publicAddress

String

微服务引擎公网访问地址，需要开启公网访问。

serviceEndpoint

Object

微服务引擎组件租户侧VPC内访问地址。

publicServiceEndpoint

Object

微服务引擎组件公网访问地址，需要开启公网访问。

表10 Endpoint

参数

参数类型

描述

kie

Object

配置中心Endpoint信息

serviceCenter

Object

服务中心Endpoint信息

表11 EntryPoint

参数

参数类型

描述

masterEntrypoint

String

微服务引擎组件VPC内ipv4主访问地址。

masterEntrypointIpv6

String

微服务引擎组件VPC内ipv6主访问地址。

slaveEntrypoint

String

微服务引擎组件VPC内ipv4备访问地址。

slaveEntrypointIpv6

String

微服务引擎组件VPC内ipv6备访问地址。

type

String

微服务引擎专享版组件类型。

取值范围：

CSE：微服务引擎专享版。

状态码： 400

表12 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

状态码： 500

表13 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

请求示例

查询指定engine_id的专享版引擎的详细信息。

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

响应示例

{
	"id": "891bf21a-4024-4f47-b38c-bd259ca8f10a",
	"name": "test",
	"description": "",
	"authType": "RBAC",
	"flavor": "cse.s1.medium2",
	"payment": "0",
	"version": "2.3.1",
	"latestVersion": "2.3.3",
	"status": "Creating",
	"beDefault": true,
	"createUser": "test",
	"createTime": 1635576800332,
	"cceSpec": {
		"id": 7465,
		"engineId": "891bf21a-4024-4f47-b38c-bd259ca8f10a",
		"specType": "CCE",
		"cluster": null,
		"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": null,
		"region": "test",
		"version": "",
		"extendParam": ""
	},
	"externalEntrypoint": {
		"externalAddress": "192.168.0.169",
		"publicAddress": "",
		"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"
                        }
		},
		"publicServiceEndpoint": {
			"kie": {
				"masterEntrypoint": "https://192.168.0.169:30110",
				"masterEntrypointIpv6": null,
				"slaveEntrypoint": null,
				"slaveEntrypointIpv6": null,
				"type": "REGISTRY"
			},
                      "serviceCenter": {
                                "masterEntrypoint": "https://192.168.0.169:30100",
				"masterEntrypointIpv6": null,
				"slaveEntrypoint": null,
				"slaveEntrypointIpv6": null,
				"type": "REGISTRY"
                        }
		}
	},
	"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"
		}
	},
	"latestJobId": 12339,
	"enterpriseProjectId": "0",
	"enterpriseProjectName": "default",
	"engineAdditionalActions": ["Retry"],
	"specType": "CSE2",
	"type": "CSE",
	"projectId": "string",
	"vmIds": [""]
}

状态码

状态码

描述

200

查询微服务引擎详情成功。

400

错误的请求。

500

服务内部错误。

错误码

请参见CSE错误码。

父主题：引擎管理

相关文档