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

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

调试

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

授权信息

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

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

请求参数

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

页码。

1
PageSizeinteger

分页大小。

10
OrderItemstring

排序属性。

GmtCreate
DescSortboolean

排序。

false
FilterParamsobject

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

Namestring

服务名。

test
SourceTypestring

来源类型。

MSE
Namespacestring

命名空间。

public
GroupNamestring

分组。

test
GatewayUniqueIdstring

网关唯一标识 ID。

gw-5017305290e14centbrveca****
ServiceProtocolstring

服务协议。

  • HTTP

  • HTTPS

  • HTTP2

  • GRPC

  • DUBBO

HTTP
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

F46CDBA4-B1EE-5C94-8A48-51C10177****
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

错误信息。

You are not authorized to perform this operation.
Codeinteger

返回值。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Dataobject

返回数据。

TotalSizelong

总条数。

9
PageNumberinteger

页码。

1
PageSizeinteger

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

10
Resultarray<object>

返回集合。

Servicesobject

数据结构。

Idlong

ID。

1
Namestring

服务名。

test
GatewayUniqueIdstring

网关唯一 ID。

gw-5017305290e14centbrveca****
GatewayIdlong

网关 ID。

1
SourceTypestring

来源类型。

MSE
Namespacestring

命名空间。

public
GroupNamestring

分组。

test
SourceIdlong

来源 ID。

2
ServiceNameInRegistrystring

注册中心中原服务名。

test
MetaInfostring

元信息或 IP 列表。

{}
Ipsarray

IP 列表。

Ipsstring

IP。

127.0.2.1
GmtCreatestring

记录创建时间。

2022-01-07 18:07:57
GmtModifiedstring

记录修改时间。

2022-01-07 18:07:57
Versionsarray<object>

服务版本。

Versionsobject

版本。

Namestring

版本名。

v1
ServiceProtocolstring

服务协议。

HTTP
ServicePortlong

服务端口。

80
HealehStatusstring

健康状态。

  • Health

  • Unhealthy

  • Unknown

Unhealthy
HealthStatusstring

健康状态。

  • Health

  • Unhealthy

  • Unknown

Unhealthy
HealthCheckboolean

是否进行健康检查。

true
HealthCheckInfoobject

健康检查信息。

Checkboolean

是否检查。

true
Protocolstring

网络协议。

TCP
Timeoutinteger

超时时间。

2
Intervalinteger

健康检查间隔。

2
HealthyThresholdinteger

健康阈值。

2
UnhealthyThresholdinteger

非健康阈值。

2
HttpPathstring

健康检查 HTTP 请求路径。

/health
HttpHoststring

健康检查 HTTP 请求地址。

http://172.168.0.1
ExpectedStatusesarray

健康检查期望状态值。

expectedStatusesinteger

期望的 HttpStatus。

200
UnhealthyEndpointsarray

非健康 endpoint 数组

unhealthyEndpointsstring

非健康 endpoint

172.168.0.1
GatewayTrafficPolicyobject

流量管理策略。

Tlsobject

TLS。

Modestring

TLS 模式。

  • DISABLE

  • SIMPLE

  • MUTUAL

  • ISTIO_MUTUAL

SIMPLE
CertIdstring

证书 ID。

5******-cn-hangzhou
CaCertIdstring

CA 证书 ID。

5******-cn-hangzhou
CaCertContentstring

CA 证书公钥。

content
SubjectAltNamesarray

主体别名数组。

SubjectAltNamestring

主体别名。

name
Snistring

服务名称标识。

name-sni
LoadBalancerSettingsobject

负载均衡设置。

LoadbalancerTypestring

负载均衡策略

  • ROUND_ROBIN

  • LEAST_CONN

  • RANDOM

  • CONSISTENT_HASH

RANDOM
ConsistentHashLBConfigobject

一致性哈希配置。

ParameterNamestring

参数名称。

param
HttpCookieobject

基于 Cookie 的参数。

Namestring

cookie 名称。

name
Pathstring

cookie 路径。

/path
Ttlstring

cookie 生命周期。

360
MinimumRingSizelong

哈希环最小值。

10000
ConsistentHashLBTypestring

一致性哈希的方式。

  • HEADER

  • COOKIE

  • SOURCE_IP

  • QUERY_PARAMETER

HEADER
WarmupDurationinteger

最小请求数的预热时间。

10
Portsarray

端口数组。

portsinteger

端口。

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
        ],
        "ServiceFQDN": ""
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-05-06OpenAPI 返回结构发生变更查看变更详情
2023-03-31API 内部配置变更,不影响调用查看变更详情
2022-02-22OpenAPI 返回结构发生变更查看变更详情
2022-02-22API 内部配置变更,不影响调用查看变更详情