文档首页> 应用管理与运维平台 ServiceStage> API参考> CSE API> 引擎管理> 查询微服务引擎专享版列表
更新时间：2024-02-06 GMT+08:00
查看PDF
分享

查询微服务引擎专享版列表

功能介绍

查询微服务引擎专享版列表。

调试

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

URI

GET /v2/{project_id}/enginemgr/engines

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量

limit

否

Integer

每页数据大小

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

当前微服务引擎专享版总个数。

data

Array of EngineInfo objects

微服务引擎专享版详情。
表5 EngineInfo

参数

参数类型

描述

id

String

微服务引擎专享版ID。

name

String

微服务引擎专享版名称。

enterpriseProjectId

String

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

enterpriseProjectName

String

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

type

String

查询的引擎类型：CSE、CSE_SHARE。

description

String

微服务引擎专享版描述。

flavor

String

微服务引擎专享版规格。

payment

String

微服务引擎专享版计费方式，0表示包周期，1表示按需，2表示免费。

authType

String

微服务引擎专享版认证方式，RBAC为安全认证，NONE为无认证。

status

String

微服务引擎专享版当前状态。

externalAddress

String

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

serviceEndpoint

Object

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

publicAddress

String

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

publicServiceEndpoint

Object

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

totalInstance

Integer

微服务引擎专享版可支持的实例总数。

usedInstance

Integer

已使用的实例总数。

availableInstance

Integer

可用的实例总数。

version

String

微服务引擎专享版当前版本。

latestVersion

String

微服务引擎专享版最新版本。

createTime

Integer

微服务引擎专享版创建时间。

dueTo

Integer

微服务引擎专享版到期时间。

latestJobId

Integer

微服务引擎专享版最近的任务ID。

engineAdditionalActions

Array of String

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

Delete：删除。

ForceDelete：强制删除。

Upgrade：升级。

Retry：重试。

Configure：变更引擎配置。

specType

String

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

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

reference

Object

微服务引擎专享版附加信息。
表6 Endpoint

参数

参数类型

描述

kie

Object

配置中心Endpoint信息。

serviceCenter

Object

服务中心Endpoint信息。
表7 EntryPoint

参数

参数类型

描述

masterEntrypoint

String

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

masterEntrypointIpv6

String

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

slaveEntrypoint

String

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

slaveEntrypointIpv6

String

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

type

String

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

CSE：微服务引擎专享版。
表8 EngineReference

参数

参数类型

描述

vpc

String

vpc名称。

vpcId

String

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

azList

Array of String

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

networkId

String

微服务引擎专享版子网网络ID。

subnetCidr

String

微服务引擎专享版ipv4子网划分。

subnetCidrV6

String

微服务引擎专享版ipv6子网划分。

subnetGateway

String

微服务引擎专享版子网网关。

publicIpId

String

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

serviceLimit

Integer

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

instanceLimit

Integer

套餐可支持的实例总数。

inputs

Map <String,String>

微服务引擎专享版附加参数。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

请求示例

查询当前的微服务引擎列表。

GET /v2/{project_id}/enginemgr/engines

响应示例

{
	"total": 1,
	"data": [{
		"id": "891bf21a-4024-4f47-b38c-bd259ca8f10a",
		"name": "test",
		"enterpriseProjectId": "0",
		"enterpriseProjectName": "default",
		"type": "CSE_SHARE",
		"description": "",
		"flavor": "cse.s1.medium2",
		"payment": "0",
		"authType": "RBAC",
		"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": 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"
                        }
		},
		"publicAddress": "",
		"publicServiceEndpoint": {
			"kie": {
				"masterEntrypoint": "",
				"masterEntrypointIpv6": "",
				"slaveEntrypoint": "",
				"slaveEntrypointIpv6": "",
				"type": "REGISTRY"
			},
                       "serviceCenter": {
                                "masterEntrypoint": "",
                                "masterEntrypointIpv6": "",
                                "slaveEntrypoint": "",
                                "slaveEntrypointIpv6": "",
                                "type": "REGISTRY"
                        }
		},
		"totalInstance": 200,
		"usedInstance": 0,
		"availableInstance": 200,
		"version": "2.3.1",
		"latestVersion": "2.3.3",
		"createTime": 1635576800332,
		"dueTo": 4102415999000,
		"latestJobId": 12339,
		"engineAdditionalActions": ["Retry"],
		"specType": "CSE2",
		"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"
			}
		}
	}]
}

状态码

状态码

描述

200

查询微服务引擎专享版列表成功。

400

错误的请求。

500

服务内部错误。

错误码

请参见CSE错误码。

父主题： 引擎管理
分享：

    相关文档

    相关产品