文档

ListServiceSource - 查询网关已关联的服务来源列表

更新时间:

查询已关联来源列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:ListServiceSourceRead
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

名称类型必填描述示例值
GatewayUniqueIdstring

网关唯一标识 ID。

gw-c51a15c7ee934a4fb945ccf35fe1****
Sourcestring

获取指定服务来源类型(为空返回所有类型):

  • 容器服务:K8s
  • MSE Nacos:MSE
  • MSE ZooKeeper:MSE_ZK
  • SAE 注册中心:SAE
  • EDAS 注册中心:EDAS
MSE
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

B8C4B0D8-EBB9-5F20-8295-04224FBE5529
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

错误信息。

You are not authorized to perform this operation.
Codeinteger

响应码。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Dataarray<object>

返回结果。

object

数据结构。

Idlong

ID。

1
Namestring

名称。

test
Addressstring

ACK ID 或 MSE 注册中心地址。

***
Typestring

类型。

NACOS
Sourcestring

来源类型。

MSE
BindingWithGatewayinteger

是否完成绑定。 (数值 1 表示完成绑定)

1
GatewayIdlong

网关 ID。

1
GmtCreatestring

创建时间。

2022-01-07 18:07:57
GmtModifiedstring

更新时间。

2022-01-07 18:07:57
SourceUniqueIdstring

来源唯一标识。

mse-cn-***
IngressOptionsobject

应用路由 Ingress 支持。

EnableIngressboolean

开启或关闭 Ingress。

true
IngressClassstring

Ingress Class。

com.test.xxx
WatchNamespacestring

监听命名空间。

default
EnableStatusboolean

是否更新 IngressStatus。

true
GatewayUniqueIdstring

网关 UniqueId。

gw-2u9uhd9283hd92hgd39g239dg2*****
GroupListarray

服务分组数组。

string

服务分组。

DEFAULT_GROUP
PathListarray

服务列表根路径数组。

string

服务列表根路径。

/path

示例

正常返回示例

JSON格式

{
  "RequestId": "B8C4B0D8-EBB9-5F20-8295-04224FBE5529",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": 1,
      "Name": "test",
      "Address": "***",
      "Type": "NACOS",
      "Source": "MSE",
      "BindingWithGateway": 1,
      "GatewayId": 1,
      "GmtCreate": "2022-01-07 18:07:57",
      "GmtModified": "2022-01-07 18:07:57",
      "SourceUniqueId": "mse-cn-***",
      "IngressOptions": {
        "EnableIngress": true,
        "IngressClass": "com.test.xxx",
        "WatchNamespace": "default",
        "EnableStatus": true
      },
      "GatewayUniqueId": "gw-2u9uhd9283hd92hgd39g239dg2*****",
      "GroupList": [
        "DEFAULT_GROUP"
      ],
      "PathList": [
        "/path"
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

变更历史

变更时间变更内容概要操作
2023-10-12OpenAPI 入参发生变更查看变更详情