首页 微服务引擎MSE API参考指南 API目录 云原生网关 服务管理 ListGatewayService - 查询网关已订阅的服务列表

ListGatewayService - 查询网关已订阅的服务列表

调用ListGatewayService接口,查询网关已订阅的服务列表。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
PageNumber integer

页码。

1
PageSize integer

分页大小。

10
OrderItem string

排序属性。

GmtCreate
DescSort boolean

排序。

false
FilterParams object

过滤条件,格式为{"key1":"value1"}。

Name string

服务名。

test
SourceType string

来源类型。

MSE
Namespace string

命名空间。

public
GroupName string

分组。

test
GatewayUniqueId string

网关唯一标识ID。

gw-5017305290e14centbrveca****
ServiceProtocol string

服务协议。

  • HTTP

  • HTTPS

  • HTTP2

  • GRPC

  • DUBBO

HTTP
AcceptLanguage string

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称 类型 描述 示例值
object

数据结构。

RequestId string

请求ID。

F46CDBA4-B1EE-5C94-8A48-51C10177****
HttpStatusCode integer

HTTP状态码。

200
Message string

错误信息。

You are not authorized to perform this operation.
Code integer

返回值。

200
Success boolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Data object

返回数据。

TotalSize long

总条数。

9
PageNumber integer

页码。

1
PageSize integer

每页最大记录数,默认值为10。

10
Result array

返回集合。

object

数据结构。

Id long

ID。

1
Name string

服务名。

test
GatewayUniqueId string

网关唯一ID。

gw-5017305290e14centbrveca****
GatewayId long

网关ID。

1
SourceType string

来源类型。

MSE
Namespace string

命名空间。

public
GroupName string

分组。

test
SourceId long

来源ID。

2
ServiceNameInRegistry string

注册中心中原服务名。

test
MetaInfo string

元信息或IP列表。

{}
Ips array

IP列表。

string

IP。

127.0.2.1
GmtCreate string

记录创建时间。

2022-01-07 18:07:57
GmtModified string

记录修改时间。

2022-01-07 18:07:57
Versions array

服务版本。

object

版本。

Name string

版本名。

v1
ServiceProtocol string

服务协议。

HTTP
ServicePort long

服务端口。

80
HealehStatus string

健康状态。

  • Health

  • Unhealthy

  • Unknown

Unhealthy
HealthStatus string

健康状态。

  • Health

  • Unhealthy

  • Unknown

Unhealthy
HealthCheck boolean

是否进行健康检查。

true
HealthCheckInfo object

健康检查信息。

Check boolean

是否检查。

true
Protocol string

网络协议。

TCP
Timeout integer

超时时间。

2
Interval integer

健康检查间隔。

2
HealthyThreshold integer

健康阈值。

2
UnhealthyThreshold integer

非健康阈值。

2
HttpPath string

健康检查HTTP请求路径。

/health
HttpHost string

健康检查HTTP请求地址。

http://172.168.0.1
ExpectedStatuses array

健康检查期望状态值。

integer

期望的HttpStatus。

200
UnhealthyEndpoints array

非健康endpoint数组

string

非健康endpoint

172.168.0.1
GatewayTrafficPolicy object

流量管理策略。

Tls object

TLS。

Mode string

TLS模式。

  • DISABLE

  • SIMPLE

  • MUTUAL

  • ISTIO_MUTUAL

SIMPLE
CertId string

证书ID。

5******-cn-hangzhou
CaCertId string

CA证书ID。

5******-cn-hangzhou
CaCertContent string

CA证书公钥。

content
SubjectAltNames array

主体别名数组。

string

主体别名。

name
Sni string

服务名称标识。

name-sni
LoadBalancerSettings object

负载均衡设置。

LoadbalancerType string

负载均衡策略

  • ROUND_ROBIN

  • LEAST_CONN

  • RANDOM

  • CONSISTENT_HASH

RANDOM
ConsistentHashLBConfig object

一致性哈希配置。

ParameterName string

参数名称。

param
HttpCookie object

基于Cookie的参数。

Name string

cookie名称。

name
Path string

cookie路径。

/path
Ttl string

cookie生命周期。

360
MinimumRingSize long

哈希环最小值。

10000
ConsistentHashLBType string

一致性哈希的方式。

  • HEADER

  • COOKIE

  • SOURCE_IP

  • QUERY_PARAMETER

HEADER
WarmupDuration integer

最小请求数的预热时间。

10
Ports array

端口数组。

integer

端口。

8080

示例

正常返回示例

JSON格式

{
  "RequestId": "F46CDBA4-B1EE-5C94-8A48-51C10177****",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Name": "test",
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "GatewayId": 1,
        "SourceType": "MSE",
        "Namespace": "public",
        "GroupName": "test",
        "SourceId": 2,
        "ServiceNameInRegistry": "test",
        "MetaInfo": "{}",
        "Ips": [
          "127.0.2.1"
        ],
        "GmtCreate": "2022-01-07 18:07:57",
        "GmtModified": "2022-01-07 18:07:57",
        "Versions": [
          {
            "Name": "v1"
          }
        ],
        "ServiceProtocol": "HTTP",
        "ServicePort": 80,
        "HealehStatus": "Unhealthy",
        "HealthStatus": "Unhealthy",
        "HealthCheck": true,
        "HealthCheckInfo": {
          "Check": true,
          "Protocol": "TCP",
          "Timeout": 2,
          "Interval": 2,
          "HealthyThreshold": 2,
          "UnhealthyThreshold": 2,
          "HttpPath": "/health",
          "HttpHost": "http://172.168.0.1",
          "ExpectedStatuses": [
            200
          ]
        },
        "UnhealthyEndpoints": [
          "172.168.0.1"
        ],
        "GatewayTrafficPolicy": {
          "Tls": {
            "Mode": "SIMPLE",
            "CertId": "5******-cn-hangzhou",
            "CaCertId": "5******-cn-hangzhou",
            "CaCertContent": "content",
            "SubjectAltNames": [
              "name"
            ],
            "Sni": "name-sni"
          },
          "LoadBalancerSettings": {
            "LoadbalancerType": "RANDOM",
            "ConsistentHashLBConfig": {
              "ParameterName": "param",
              "HttpCookie": {
                "Name": "name",
                "Path": "/path",
                "Ttl": "360"
              },
              "MinimumRingSize": 10000,
              "ConsistentHashLBType": "HEADER"
            },
            "WarmupDuration": 10
          }
        },
        "Ports": [
          8080
        ]
      }
    ]
  }
}

错误码

Http code 错误码 错误信息 描述
400 duplicatedClusterAliasName duplicated cluster alias name 实例名称已重复,请换一个
400 illegalRequest illegal request:%s 非法请求:%s
400 invalidParameter parameter error:%s 请求入参异常:%s
403 NoPermission You are not authorized to perform this operation. 没有权限使用此接口
404 clusterNotFound cluster not found 找不到此集群
500 systemError system error 系统开小差了,请稍后重试
500 regcenterError register center error:%s 注册配置中心请求错误:%s

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

变更历史

变更时间 变更内容概要 操作
2022-02-22 OpenAPI 返回结构发生变更
变更项 变更内容
出参 OpenAPI 返回结构发生变更
2022-02-22 API 内部配置变更,不影响调用
变更项 变更内容
API 内部配置变更,不影响调用
阿里云首页 微服务引擎 相关技术圈