文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 泳道组/ 根据网关ID获取目标服务列表
更新时间：2024-10-11 GMT+08:00
查看PDF
分享

根据网关ID获取目标服务列表

功能介绍

此API用于根据网关ID获取目标服务列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/cas/swimlane-group/target-services

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。
表2 查询参数

参数

是否必选

参数类型

描述

gateway_id

是

String

网关ID。

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息

表4 响应参数

参数

参数类型

描述

id

String

目标服务ID。

host

String

目标服务host信息。

host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成，以点号（.）分隔。

例如，unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称，testing为unit-controller微服务所在环境名，test-application为unit-controller微服务所属应用名称，servicecomb表示unit-controller微服务接入的是ServiceComb引擎。

name

String

目标服务名称。

service_source_name

String

目标服务对应的服务来源名称。

engine_id

String

目标服务对应的服务来源引擎ID。

engine_type

String

目标服务对应的服务来源引擎类型。

swimlane_group_id

String

泳道组ID。

swimlane_group_name

String

泳道组名称。

status

String

目标服务状态。

  • TARGET_SERVICE_MANAGED：目标服务已经被纳管。
  • MICROSERVICE_OF_TARGET_SERVICE_UNROUTING：目标服务对应的微服务不支持路由。
  • MICROSERVICE_OF_TARGET_SERVICE_MANAGED：目标服务对应的微服务被纳管。

请求示例

无

响应示例

[
    {
        "id": "8177d237-b912-4167-a90d-33c603610d0b",
        "host": "provider..demo-java-chassis-cse-v2.servicecomb",
        "name": "provider",
        "service_source_name": "cscs",
        "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067",
        "engine_type": "servicecomb",
        "swimlane_group_id": null,
        "swimlane_group_name": null,
        "status": null
    },
    {
        "id": "8d8d5d85-2ae6-463b-b2e9-0fa9d9a0aa7d",
        "host": "test.static",
        "name": "test",
        "service_source_name": "static",
        "engine_id": null,
        "engine_type": null,
        "swimlane_group_id": null,
        "swimlane_group_name": null,
        "status": "MICROSERVICE_OF_TARGET_SERVICE_UNROUTING"
    }
]

状态码

状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

错误码格式为：SVCSTG.00100.[Error_ID]，例如：SVCSTG.00100400。错误码说明请参考ServiceStage错误码。

父主题： 泳道组

相关文档