ListExternalServices - 获取外部服务-API 网关(API Gateway)-阿里云帮助中心

接口说明

接口支持创建多个服务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:ListExternalServices

none

*Gateway

acs:apig:{#regionId}:{#accountId}:gateway/{#GatewayId}

无

请求语法

GET /v1/gateways/{gatewayId}/external-services HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
gatewayId	string	否	网关 id，精确搜索。	gw-d76t026m1hkv70tla0e0

请求参数

名称	类型	必填	描述	示例值
sourceType	string	否	根据服务来源类型查询, 服务来源。本参数实际为必填项，未提供时 API 返回 400 InvalidParameter.WithValue。允许值：SAE_K8S_SERVICE、PAI_EAS_SERVICE、CloudFlow、K8S、FC3、PAI_WORKSPACE、MSE_NACOS。枚举值： SAE_K8S_SERVICE : SAE K8s Service（按 VPC 列出 SAE 应用） PAI_EAS_SERVICE : PAI-EAS 服务（需配合 paiWorkspaceId 参数） CloudFlow : 云工作流 CloudFlow K8S : 容器服务 K8s 集群中的服务（依赖网关已关联 K8s 服务来源） FC3 : 函数计算 FC 3.0 的函数 PAI_WORKSPACE : PAI 工作空间（非正式服务来源，用于间接获取 PAI-EAS 服务） MSE_NACOS : MSE Nacos 注册中心中的服务（支持多 Nacos 实例聚合）	FC3
limit	integer	否	限制返回数量，有效范围(0, 100]，不填默认 10	100
nameLike	string	否	按接口名称模糊搜索	imah
importableOnly	boolean	否	是否只返回"尚未导入"的服务	true
paiWorkspaceId	string	否	PAI-EAS 服务的工作空间 id	667435

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID。	D9B03B59-B2D6-51B0-A7E9-AF8466E320CA
code	string	响应码。	Ok
message	string	响应信息。	Failed to upload data. Please try again
data	object	接口列表。
items	array<object>	服务信息。
	array<object>	可用区 ID。
namespace	string	命名空间	PUBLIC
namespaceShowName	string	命名空间的展示名	PUBLIC
services	array<object>	后端服务。
	object	后端服务。
name	string	名称	enable-slash-merge
namespace	string	命名空间。	public

示例

正常返回示例

JSON格式

{
  "requestId": "D9B03B59-B2D6-51B0-A7E9-AF8466E320CA",
  "code": "Ok",
  "message": "Failed to upload data. Please try again",
  "data": {
    "items": [
      {
        "namespace": "PUBLIC",
        "namespaceShowName": "PUBLIC",
        "services": [
          {
            "name": "enable-slash-merge",
            "namespace": "public"
          }
        ]
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。