Help Center/ ServiceStage/ API Reference/ CSE APIs/ Engine Management/ Querying Details About an Exclusive Microservice Engine

Updated on 2024-10-16 GMT+08:00

View PDF

Querying Details About an Exclusive Microservice Engine

Function

This API is used to query details about an exclusive microservice engine.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant ID, which must be unique. The value contains 1 to 64 characters. See Obtaining a Project ID.
engine_id	Yes	String	ID of an exclusive microservice engine. See Querying the Exclusive Microservice Engine List.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Enterprise-Project-ID	No	String	Enterprise project ID. If this parameter is not set, the default enterprise project is default and the ID is 0.

Response

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	ID of an exclusive microservice engine.
name	String	Name of an exclusive microservice engine.
projectId	String	ID of the project to which an exclusive microservice engine belongs.
enterpriseProjectId	String	ID of the enterprise project to which an exclusive microservice engine belongs. .
enterpriseProjectName	String	Name of the enterprise project to which an exclusive microservice engine belongs. .
type	String	Engine type. CSE: exclusive microservice engine.
description	String	Description of an exclusive microservice engine.
beDefault	Boolean	Whether the exclusive engine is the default engine.
flavor	String	Flavor of an exclusive microservice engine. cse.s1.small2: HA 100-instance engine cse.s1.medium2: HA 200-instance engine cse.s1.large2: HA 500-instance engine cse.s1.xlarge2: HA 2000-instance engine
payment	String	Billing mode of an exclusive microservice engine. 1 indicates pay-per-use, and 2 indicates free of charge.
authType	String	Authentication mode of an exclusive microservice engine. RBAC indicates security authentication, and NONE indicates no authentication.
authConfig	Table 4	RBAC configuration of a microservice engine.
status	String	Current status of an exclusive microservice engine.
cceSpec	Object	CCE specification of an exclusive microservice engine.
externalEntrypoint	Object	Access address of an exclusive microservice engine.
publicAddress	String	Public network access address of an exclusive microservice engine. You need to enable public network access.
version	String	Current version of an exclusive microservice engine.
latestVersion	String	Latest version of an exclusive microservice engine.
createTime	Integer	Creation time of an exclusive microservice engine.
createUser	String	Creator of an exclusive microservice engine.
latestJobId	Integer	ID of the latest job of an exclusive microservice engine.
engineAdditionalActions	Array of String	Additional operations allowed by an exclusive microservice engine. Delete ForceDelete Upgrade Retry
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 an exclusive microservice engine.
vmIds	Array of String	ID list of VMs used by an exclusive microservice engine on the resource tenant side.

**Table 4** authConfig
Parameter	Type	Description
consoleAuthEnabled	Boolean	Whether to enable console authentication.
sdkAuthEnabled	Boolean	Whether to enable programming interface authentication.

**Table 5** 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 exclusive microservice engine deployment.
networkId	String	Subnet network ID of an exclusive microservice engine.
subnetCidr	String	IPv4 subnet division of an exclusive microservice engine.
subnetCidrV6	String	IPv6 subnet division of an exclusive microservice engine.
subnetGateway	String	Subnet gateway of an exclusive microservice engine.
publicIpId	String	Public IP address ID of an exclusive 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.

**Table 6** Spec
Parameter	Type	Description
id	Integer	CCE specification ID of an exclusive microservice engine.
engineId	String	ID of an exclusive microservice engine.
specType	String	CCE cluster deployment type of an exclusive microservice engine.
cluster	String	CCE cluster information about an exclusive microservice engine. Currently, the value is null.
clusterId	String	CCE cluster ID of an exclusive microservice engine.
clusterNodes	Object	CCE node list of an exclusive microservice engine.
flavor	String	CCE cluster flavor of an exclusive microservice engine.
region	String	Region where the CCE cluster of an exclusive microservice engine is located.
version	String	CCE cluster version of an exclusive microservice engine.
extendParam	String	Additional parameter of the CCE cluster of an exclusive microservice engine.

**Table 7** SpecClusterNode
Parameter	Type	Description
clusterNodes	Array of ClusterNode objects	CCE node information of an exclusive microservice engine.

**Table 8** 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 status of an exclusive microservice engine.

**Table 9** EngineExternalEntrypoint
Parameter	Type	Description
externalAddress	String	Address for accessing an exclusive microservice engine in a VPC on the tenant side.
publicAddress	String	Public network access address of an exclusive microservice engine. You need to enable public network access.
serviceEndpoint	Object	Address for accessing an exclusive microservice engine component in a VPC on the tenant side.
publicServiceEndpoint	Object	Public network access address of an exclusive microservice engine component. You need to enable public network access.

**Table 10** Endpoint
Parameter	Type	Description
kie	Object	Endpoint information of the configuration center.
serviceCenter	Object	Endpoint information of the service center.

**Table 11** EntryPoint
Parameter	Type	Description
masterEntrypoint	String	Primary IPv4 address for accessing an exclusive microservice engine component in a VPC.
masterEntrypointIpv6	String	Primary IPv6 address for accessing an exclusive microservice engine component in a VPC.
slaveEntrypoint	String	Secondary IPv4 address for accessing an exclusive microservice engine component in a VPC.
slaveEntrypointIpv6	String	Secondary IPv6 address for accessing an exclusive microservice engine component in a VPC.
type	String	Type of an exclusive microservice engine component. CSE

Status code: 400

**Table 12** Response body parameters
Parameter	Type	Description
errorCode	String	Error code.
errorMessage	String	Error message.
detail	String	Location details.

Status code: 500

**Table 13** Response body parameters
Parameter	Type	Description
errorCode	String	Error code.
errorMessage	String	Error message.
detail	String	Location details.

Example Request

Query details about an exclusive engine with specified engine_id.

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

Example Response

{
	"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": [""]
}