Querying the Microservice Engine List
Function
This API is used to query the microservice engine list.
URI
GET /v2/{project_id}/enginemgr/engines
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID, which must be unique. The value contains 1 to 64 characters. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
Yes |
Integer |
Page number. |
limit |
Yes |
String |
Number of records displayed on each page. |
type |
No |
String |
|
Request
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
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of microservice engines that meet the search criteria. |
data |
Array of EngineSimpleInfo objects |
Microservice engine details. |
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 |
Microservice engine type.
Enumerated values:
|
description |
String |
Microservice engine description. |
flavor |
String |
Microservice engine flavor.
Enumerated values:
|
payment |
String |
Billing mode of a microservice engine. 0 indicates yearly/monthly, 1 indicates pay-per-use, and 2 indicates free of charge. |
authType |
String |
Billing mode of a microservice engine. Value: RBAC or NONE. Enumerated values:
|
status |
String |
Current status of a microservice engine. Enumerated values:
|
externalAddress |
String |
External IP address of a microservice engine. |
serviceEndpoint |
Map<String,EntrypointItem> |
Address for accessing a microservice engine component. |
publicAddress |
String |
Public IP address of a microservice engine. |
publicServiceEndpoint |
Map<String,EntrypointItem> |
Public access address of a microservice engine. |
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 |
Long |
Creation time of a microservice engine. |
dueTo |
Long |
Expiration time of a microservice engine. |
latestJobId |
Integer |
ID of the latest job of a microservice engine. |
engineAdditionalActions |
Array of strings |
Additional operations allowed by a microservice engine. Enumerated values:
|
specType |
String |
Deployment type of a microservice engine. Enumerated values:
|
reference |
EngineReference object |
Additional information about a microservice engine. |
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:
|
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 |
Integer |
Total number of microservices supported by a microservice engine. |
instanceLimit |
Integer |
Total number of instances supported by a microservice engine. |
inputs |
Map<String,String> |
Additional parameter of a microservice engine. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
detail |
String |
Location details. |
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
Example Response
Status code: 200
Response structure for querying the microservice engine list.
{
"total" : 0,
"data" : [ {
"id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
"name" : "test",
"enterpriseProjectId" : "0",
"enterpriseProjectName" : "default",
"type" : "CSE",
"description" : "string",
"flavor" : "cse.s1.medium2",
"payment" : "0",
"authType" : "NONE",
"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" : "string",
"slaveEntrypointIpv6" : "string",
"type" : "REGISTRY"
}
},
"publicAddress" : "",
"publicServiceEndpoint" : {
"kie" : {
"masterEntrypoint" : "",
"masterEntrypointIpv6" : "",
"slaveEntrypoint" : "",
"slaveEntrypointIpv6" : "",
"type" : "REGISTRY"
}
},
"totalInstance" : 200,
"usedInstance" : 0,
"availableInstance" : 200,
"version" : "2.3.1",
"latestVersion" : "2.3.4",
"createTime" : 1635576800332,
"dueTo" : 4102415999000,
"latestJobId" : 12339,
"engineAdditionalActions" : [ "Retry" ],
"specType" : "CSE2",
"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" : {
"is_arm_cluster" : "true",
"nodeFlavor" : "s6.large.2"
}
}
} ]
}
Status Code
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
500 |
Internal Server Error |
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot