# 查询微服务引擎列表 - QueryMicroserviceEngineList #### 功能介绍 查询微服务引擎列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CSE/doc?api=ListEngines)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cse:engine:list | list | - | - | - | - | #### URI GET /v2/{project_id}/enginemgr/engines 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 租户子项目的唯一标识，字符长度为1\~64位，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | 偏移量 | | limit | 否 | Integer | 每页数据大小 | | type | 否 | String | 查询的引擎类型。 **取值范围：** - CSE：微服务引擎专享版。 - CSE_SHARE：微服务引擎共享版。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 当前微服务引擎总个数。 | | data | Array of [EngineInfo] objects | 微服务引擎详情。 | 表5EngineInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 微服务引擎当前状态。 **取值范围：** - Creating：创建中 - Available：可用 - Unavailable：不可用 - Deleting：删除中 - Deleted：已删除 - Upgrading：升级中 - Modifying：变更中 - CreateFailed：创建失败 - DeleteFailed：删除失败 - UpgradeFailed：升级失败 - ModifyFailed：变更失败 - Freezed：已冻结 | | 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 strings | 微服务引擎允许的附加操作。 **取值范围：** - Delete：删除。 - ForceDelete：强制删除。 - Upgrade：升级。 - Retry：重试。 - Configure：变更引擎配置。 | | specType | String | 微服务引擎专享版部署类型。 - 1.x引擎时，固定值CSE。 - 2.x引擎时，固定值为CSE2。 | | reference | [Object] | 微服务引擎附加信息。 | 表6Endpoint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | kie | [Object] | 配置中心Endpoint信息。 | | serviceCenter | [Object] | 服务中心Endpoint信息。 | 表7EntryPoint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | masterEntrypoint | String | 微服务引擎组件VPC内ipv4主访问地址。 | | masterEntrypointIpv6 | String | 微服务引擎组件VPC内ipv6主访问地址。 | | slaveEntrypoint | String | 微服务引擎组件VPC内ipv4备访问地址。 | | slaveEntrypointIpv6 | String | 微服务引擎组件VPC内ipv6备访问地址。 | | type | String | 微服务引擎专享版组件类型。 **取值范围：** - REGISTRY：注册中心。 - SERVICE：服务治理。 | 表8EngineReference | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 \ | 微服务引擎附加参数。 | **状态码： 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错误码](https://support.huaweicloud.com/api-servicestage/cse_06_0136.html)。