全部产品
Search
文档中心

微服务引擎MSE:GetServiceListPage - 获取服务列表

更新时间:Nov 13, 2024

获取服务列表

调试

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

授权信息

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

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

请求参数

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

地域。

cn-hangzhou
Namespacestring

MSE 命名空间名字

default
AppNamestring

应用名字。

example-app
ServiceTypestring

服务类型。

springCloud
AppIdstring

应用 id。

dez4xxxxx@f3f75ed8ffxxxxx
ServiceNamestring

服务名字。

sc-A
PageNumberinteger

页数。

1
PageSizeinteger

每页大小。

10
Ipstring

要查询的 ip 地址。

223.5.5.5
AcceptLanguagestring

返回结果显示的语言。取值:zh(默认值):中文,en:英文

zh

返回参数

名称类型描述示例值
object
Successboolean

请求是否成功。

True
Messagestring

请求信息。

OK
RequestIdstring

请求 id。

A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx
Dataobject

请求响应数据。

Resultarray<object>

当前页面数据。

MscServiceResponseobject

每个服务的信息。

AppNamestring

应用名。

example-app
Versionstring

服务版本。

1
InstanceNuminteger

服务对应的节点数。

1
GmtModifyTimestring

服务最后的更新时间。

123456
AppIdstring

应用 id。

dez4xxxxx@f3f75ed8ffxxxxx
ServiceNamestring

服务名。

sc-A
Groupstring

服务分组。

DEFAULT_GROUP
TotalSizestring

数据总数。

100
PageNumberstring

当前页码。

1
PageSizestring

页面大小。

10

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Message": "OK",
  "RequestId": "A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx",
  "Data": {
    "Result": [
      {
        "AppName": "example-app",
        "Version": "1",
        "InstanceNum": 1,
        "GmtModifyTime": "123456",
        "AppId": "dez4xxxxx@f3f75ed8ffxxxxx",
        "ServiceName": "sc-A",
        "Group": "DEFAULT_GROUP",
        "ServiceType": ""
      }
    ],
    "TotalSize": "100",
    "PageNumber": "1",
    "PageSize": "10"
  }
}

错误码

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-09-25OpenAPI 返回结构发生变更查看变更详情
2023-09-13OpenAPI 入参发生变更查看变更详情