# 查询微服务引擎列表 - 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-cse/cse_06_0081.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cse:engine:list | list | - | - | - | - | #### URI GET /v2/{project_id}/enginemgr/engines 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 租户子项目的唯一标识。字符长度为1\~64。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 是 | Integer | 分页的页码。 | | limit | 是 | String | 每页显示的条目数量。 | | type | 否 | String | - 查询所有微服务引擎需要将该值设置为ALL。 - 查询ServiceComb引擎需要将该值设置为CSE。 - 查询注册配置中心需要将该值设置为Nacos。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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"。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 当前符合查询条件的微服务引擎总个数。 | | data | Array of [EngineSimpleInfo] objects | 微服务引擎详情。 | 表5EngineSimpleInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 微服务引擎的ID。 | | name | String | 微服务引擎的名称。 | | enterpriseProjectId | String | 微服务引擎的所属企业项目ID。 | | enterpriseProjectName | String | 微服务引擎所属企业项目名称。 | | type | String | 微服务引擎的类型。 **取值范围：** - CSE：为ServiceComb引擎专享版。 - NACOS：为注册配置中心。 | | description | String | 微服务引擎的描述。 | | flavor | String | 微服务引擎的规格。 - cse.s1.xxx对应ServiceComb引擎专享版的规格。 - cse.nacos2.xxx对应注册配置中心的规格。 **取值范围** **：** - cse.s1.small2 - cse.s1.medium2 - cse.s1.large2 - cse.s1.xlarge2 - cse.s1.small3 - cse.s1.medium3 - cse.s1.large3 - cse.s1.xlarge3 - cse.nacos2.c1.large.10 - cse.nacos2.c1.xlarge.20 - cse.nacos2.c1.xlarge.50 - cse.nacos2.c1.xlarge.60 - cse.nacos2.c1.2xlarge.100 说明： 以下规格当前只在西南-贵阳-汽车二局点支持。 - cse.s1.small3 - cse.s1.medium3 - cse.s1.large3 - cse.s1.xlarge3 | | 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 | 微服务引擎暴露的IP地址。 | | serviceEndpoint | Map\ | 微服务引擎组件的访问地址。 | | publicAddress | String | 微服务引擎的公网IP地址。 | | publicServiceEndpoint | Map\ | 微服务引擎的公网接入地址。 | | totalInstance | Integer | 微服务引擎可支持的实例总数。 | | usedInstance | Integer | 已使用的实例总数。 | | availableInstance | Integer | 可用实例总数。 | | version | String | 微服务引擎的当前版本。 | | latestVersion | String | 微服务引擎的最新版本。 | | createTime | Long | 微服务引擎的创建时间。 | | dueTo | Long | 微服务引擎的到期时间。 | | latestJobId | Integer | 微服务引擎最近的任务ID。 | | engineAdditionalActions | Array of strings | 微服务引擎允许的附加操作。 **取值范围** **：** - ForceDelete：强制删除。 - Rollback：恢复。 - Retry：重试。 | | specType | String | 微服务引擎的应用部署类型。 **取值范围** **：** - CSE2 - CSE3 - Nacos2 说明： 当前CSE3只在西南-贵阳-汽车二局点支持。 | | reference | [EngineReference] object | 微服务引擎附加信息。 | | tags | String | 微服务引擎标签。 | 表6EntrypointItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | masterEntrypoint | String | 微服务引擎专享版组件的ipv4主接入地址。 | | masterEntrypointIpv6 | String | 微服务引擎专享版组件的ipv6主接入地址。 | | slaveEntrypoint | String | 微服务引擎专享版组件的ipv4备接入地址。 | | slaveEntrypointIpv6 | String | 微服务引擎专享版组件的ipv6备接入地址。 | | type | String | 微服务引擎专享版组件类型。 **取值范围** **：** - REGISTRY：注册中心。 - SERVICE：服务治理。 | 表7EngineReference | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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\ | 微服务引擎的附加参数。 | **状态码： 400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误信息。 | | detail | String | 详细定位信息。 | **状态码： 500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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错误码](https://support.huaweicloud.com/api-cse/cse_06_0109.html)。