文档首页/ 微服务引擎 CSE/ API参考/ CSE API/ 引擎管理/ 查询微服务引擎的详情

更新时间：2024-08-02 GMT+08:00

查看PDF

查询微服务引擎的详情

功能介绍

查询指定微服务引擎的详情

调试

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

URI

GET /v2/{project_id}/enginemgr/engines/{engine_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户子项目的唯一标识。字符长度为1~64。
engine_id	是	String	微服务引擎ID。

请求参数

表2 请求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

表3 响应Body参数
参数	参数类型	描述
id	String	微服务引擎的ID
name	String	微服务引擎的名称
description	String	微服务引擎的描述
authType	String	微服务引擎的认证类型枚举值： RBAC NONE
flavor	String	微服务引擎的规格
payment	String	微服务引擎的计费方式
version	String	微服务引擎的当前版本
latestVersion	String	微服务引擎的最新版本
status	String	微服务引擎的状态枚举值： Creating Available Unavailable Deleting Deleted Upgrading Modifying CreateFailed DeleteFailed UpgradeFailed ModifyFailed Freezed
beDefault	Boolean	engine 是否是默认引擎
createUser	String	微服务引擎的创建者
createTime	Long	微服务引擎的创建时间
cceSpec	Spec object	微服务引擎的应用规格
externalEntrypoint	EngineExternalEntrypoint object	微服务引擎对的外暴露节点地址
reference	EngineReference object	微服务引擎的相关参数
latestJobId	Integer	微服务引擎的最近的任务ID
enterpriseProjectId	String	微服务引擎的所属企业项目ID
enterpriseProjectName	String	微服务引擎的所属企业项目名称
engineAdditionalActions	Array of strings	微服务引擎的允许的附加操作枚举值： ForceDelete Rollback Retry
specType	String	微服务引擎的部署类型缺省值：CSE 枚举值： CCE CSE SpringCloud
type	String	微服务引擎的类型，CSE为ServiceComb引擎专享版，NACOS为注册配置中心，MICROGATEWAY为应用网关（公测）。枚举值： CSE NACOS MICROGATEWAY
projectId	String	微服务引擎专享版所属项目ID
vmIds	Array of strings	当前引擎在资源租户侧使用的虚拟机 id 列表

表4 Spec
参数	参数类型	描述
id	Long	微服务引擎的CCE规格ID
engineId	String	微服务引擎的ID
specType	String	微服务引擎的CCE集群部署类型枚举值： CCE CSE SpringCloud
cluster	String	微服务引擎的CCE集群信息，目前为null
clusterId	String	微服务引擎的CCE集群ID
clusterNodes	SpecClusterNode object	微服务引擎专享版CCE节点列表
flavor	String	微服务引擎的CCE集群规格
region	String	微服务引擎的CCE集群所在region
version	String	微服务引擎的CCE集群版本
extendParam	String	微服务引擎的CCE集群附加参数

表5 SpecClusterNode
参数	参数类型	描述
clusterNodes	Array of ClusterNode objects	CCE节点信息。

表6 ClusterNode
参数	参数类型	描述
id	String	微服务引擎专享版CCE节点ID
az	String	微服务引擎专享版CCE节点所属可用区
ip	String	微服务引擎专享版CCE节点IP
label	String	微服务引擎专享版CCE节点标签
status	String	微服务引擎专享版CCE节点状态缺省值：Active

表7 EngineExternalEntrypoint
参数	参数类型	描述
externalAddress	String	微服务引擎专享版暴露的IP地址。
publicAddress	String	微服务引擎专享版的公网地址。
serviceEndpoint	Map<String,EntrypointItem>	微服务引擎专享版组件的访问地址。
publicServiceEndpoint	Map<String,EntrypointItem>	微服务引擎专享版组件的公网地址。

表8 EntrypointItem
参数	参数类型	描述
masterEntrypoint	String	微服务引擎专享版组件的ipv4主接入地址
masterEntrypointIpv6	String	微服务引擎专享版组件的ipv6主接入地址
slaveEntrypoint	String	微服务引擎专享版组件的ipv4备接入地址
slaveEntrypointIpv6	String	微服务引擎专享版组件的ipv6备接入地址
type	String	微服务引擎专享版组件类型枚举值： REGISTRY SERVICE

表9 EngineReference
参数	参数类型	描述
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>	微服务引擎的附加参数

状态码： 400

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息。
detail	String	详细定位信息。

状态码： 500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息。
detail	String	详细定位信息。

请求示例

GET https://{endpoint}/v2/{project_id}/enginemgr/engines/{engine_id}

响应示例

状态码： 200

查询微服务引擎详情响应结构体。

{
  "id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
  "name" : "test",
  "description" : "string",
  "authType" : "NONE",
  "flavor" : "cse.s1.medium2",
  "payment" : "0",
  "version" : "2.3.1",
  "latestVersion" : "2.3.4",
  "status" : "Creating",
  "beDefault" : true,
  "createUser" : "string",
  "createTime" : 1635576800332,
  "cceSpec" : {
    "id" : 7465,
    "engineId" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
    "specType" : "CCE",
    "cluster" : "",
    "clusterId" : "41115a6f-912f-11eb-9af9-0255ac100188",
    "clusterNodes" : {
      "clusterNodes" : [ {
        "id" : "c13aaf5c-2192-421c-8e03-522e2b9a06b5",
        "az" : "test",
        "ip" : "172.31.25.277",
        "label" : "test",
        "status" : "Active"
      } ]
    },
    "flavor" : "string",
    "region" : "test",
    "version" : "",
    "extendParam" : ""
  },
  "externalEntrypoint" : {
    "externalAddress" : "192.168.0.169",
    "publicAddress" : "",
    "serviceEndpoint" : {
      "serviceCenter" : {
        "masterEntrypoint" : "https://192.168.0.169:30110",
        "masterEntrypointIpv6" : "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30110",
        "slaveEntrypoint" : "",
        "slaveEntrypointIpv6" : "",
        "type" : "REGISTRY"
      }
    },
    "publicServiceEndpoint" : {
      "serviceCenter" : {
        "masterEntrypoint" : "",
        "masterEntrypointIpv6" : "",
        "slaveEntrypoint" : "",
        "slaveEntrypointIpv6" : "",
        "type" : "REGISTRY"
      }
    }
  },
  "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" : {
      "nodeFlavor" : "s6.large.2",
      "is_arm_cluster" : "false"
    }
  },
  "latestJobId" : 12339,
  "enterpriseProjectId" : "0",
  "enterpriseProjectName" : "default",
  "engineAdditionalActions" : [ "Noting" ],
  "specType" : "CSE2",
  "type" : "CSE",
  "projectId" : "string",
  "vmIds" : [ ]
}

状态码

状态码	描述
200	查询微服务引擎详情响应结构体。
400	错误的请求。
500	服务器内部错误。

错误码

请参见错误码。

父主题： 引擎管理

上一篇：创建微服务引擎

下一篇：查询微服务引擎任务详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询微服务引擎的详情

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线