查询微服务引擎列表
功能介绍
查询微服务引擎列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/enginemgr/engines
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户子项目的唯一标识。字符长度为1~64。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Integer |
分页的页码。 |
|
limit |
是 |
String |
每页显示的条目数量。 |
|
type |
否 |
String |
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 |
|
X-Enterprise-Project-ID |
否 |
String |
如果不带则默认企业项目为"default"，ID为"0"。 |
|
Content-Type |
是 |
String |
该字段内容填为 "application/json;charset=UTF-8"。 |
|
Accept |
是 |
String |
该字段内容填为 "application/json"。 |
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
当前符合查询条件的微服务引擎总个数。 |
|
data |
Array of EngineSimpleInfo objects |
微服务引擎详情。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
微服务引擎的ID。 |
|
name |
String |
微服务引擎的名称。 |
|
enterpriseProjectId |
String |
微服务引擎的所属企业项目ID。 |
|
enterpriseProjectName |
String |
微服务引擎所属企业项目名称。 |
|
type |
String |
微服务引擎的类型。
枚举值：
|
|
description |
String |
微服务引擎的描述。 |
|
flavor |
String |
微服务引擎的规格。
枚举值：
|
|
payment |
String |
微服务引擎的计费方式，0表示包周期，1表示按需，2表示免费。 |
|
authType |
String |
微服务引擎的认证方式，RBAC/NONE。 枚举值：
|
|
status |
String |
微服务引擎当前的状态。 枚举值：
|
|
externalAddress |
String |
微服务引擎暴露的IP地址。 |
|
serviceEndpoint |
Map<String,EntrypointItem> |
微服务引擎组件的访问地址。 |
|
publicAddress |
String |
微服务引擎的公网IP地址。 |
|
publicServiceEndpoint |
Map<String,EntrypointItem> |
微服务引擎的公网接入地址。 |
|
totalInstance |
Integer |
微服务引擎可支持的实例总数。 |
|
usedInstance |
Integer |
已使用的实例总数。 |
|
availableInstance |
Integer |
可用实例总数。 |
|
version |
String |
微服务引擎的当前版本。 |
|
latestVersion |
String |
微服务引擎的最新版本。 |
|
createTime |
Long |
微服务引擎的创建时间。 |
|
dueTo |
Long |
微服务引擎的到期时间。 |
|
latestJobId |
Integer |
微服务引擎最近的任务ID。 |
|
engineAdditionalActions |
Array of strings |
微服务引擎允许的附加操作。 枚举值：
|
|
specType |
String |
微服务引擎的应用部署类型。 枚举值：
|
|
reference |
EngineReference object |
微服务引擎附加信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
masterEntrypoint |
String |
微服务引擎专享版组件的ipv4主接入地址。 |
|
masterEntrypointIpv6 |
String |
微服务引擎专享版组件的ipv6主接入地址。 |
|
slaveEntrypoint |
String |
微服务引擎专享版组件的ipv4备接入地址。 |
|
slaveEntrypointIpv6 |
String |
微服务引擎专享版组件的ipv6备接入地址。 |
|
type |
String |
微服务引擎专享版组件类型。 枚举值：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vpc |
String |
vpc名称。 |
|
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> |
微服务引擎的附加参数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
detail |
String |
详细定位信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
detail |
String |
详细定位信息。 |
请求示例
GET https://{endpoint}/v2/{project_id}/enginemgr/engines响应示例
状态码： 200
查询微服务引擎列表响应结构体。
{
"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"
}
}
} ]
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询微服务引擎列表响应结构体。 |
|
400 |
错误的请求。 |
|
500 |
服务器内部错误。 |
错误码
请参见CSE错误码。
