文档

GetServiceList - 查询应用服务信息

更新时间:

通过GetServiceList接口查询应用服务信息。

调试

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

授权信息

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

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

请求参数

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

地域。

cn-zhangjiakou
ServiceTypestring

框架类型。

dubbo
AppIdstring

应用 ID。

xxx@xxx
ServiceNamestring

服务名。

com.alibaba.xxx
Ipstring

IP 地址。

127.0.0.1
AcceptLanguagestring

语言类型。

zh

返回参数

名称类型描述示例值
object

数据结构。

HttpStatusCodeinteger

Http 状态码。

200
Messagestring

响应信息。

success
RequestIdstring

请求 ID。

xxx-xxx-xxx
Dataarray<object>

返回数据。

object

返回结果。

EdasAppNamestring

应用名。

test
DubboApplicationNamestring

Dubbo 应用名。

dubbo-application
Versionstring

版本信息。

1.0.0
SpringApplicationNamestring

Spring 应用名。

spring-application
RegistryTypestring

注册中心类型。

nacos
ServiceTypestring

服务类型。

dubbo
ServiceNamestring

服务名。

com.alibaba.xxx
Methodsarray<object>

方法列表。

object

方法列表。

Pathsarray

路径。

string

服务映射地址。

/path
ParameterTypesarray

参数类型。

string

参数类型。

int
RequestMethodsarray

方法。

string

方法。

sayHello
Namestring

方法名。

sayHello
MethodControllerstring

方法接口。

com.alibaba.SayHelloController
ReturnTypestring

返回值类型。

int
Metadataobject

元数据。

{}
Groupstring

分组。

dubbo
Codeinteger

状态码。

200
Successboolean

调用成功与否。

true

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Message": "success",
  "RequestId": "xxx-xxx-xxx",
  "Data": [
    {
      "EdasAppName": "test",
      "DubboApplicationName": "dubbo-application",
      "Version": "1.0.0",
      "SpringApplicationName": "spring-application",
      "RegistryType": "nacos",
      "ServiceType": "dubbo",
      "ServiceName": "com.alibaba.xxx",
      "Methods": [
        {
          "Paths": [
            "/path"
          ],
          "ParameterTypes": [
            "int"
          ],
          "RequestMethods": [
            "sayHello"
          ],
          "Name": "sayHello",
          "MethodController": "com.alibaba.SayHelloController",
          "ReturnType": "int"
        }
      ],
      "Metadata": {},
      "Group": "dubbo"
    }
  ],
  "Code": 200,
  "Success": true
}

错误码

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

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