GetServiceDetail - 获取服务详情

调用GetServiceDetail接口获取服务详情。

调试

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

调试

授权信息

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

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

请求参数

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

地域ID。

cn-hangzhou
namespacestring

命名空间ID。

cn-hangzhou:doc-test
originstring

数据来源,取值如下:

  • agent:新版服务查询需要传递。
  • registry:旧版服务查询传递。
agent
serviceTypestring

服务类型,取值如下:

  • dubbo
  • springCloud
  • hsf
  • istio
springCloud
appIdstring

应用ID。

efbda488-7b33-432f-a40d-****0047****
sourcestring

来源,固定值:edas。

edas
serviceIdstring

服务ID。已废弃,无需设置。

com.alibabacloud.hipstershop.CartService
serviceNamestring

服务名称。

com.alibabacloud.hipstershop.CartService
serviceVersionstring

服务版本。

1.0.0
groupstring

服务分组。

DUBBO
ipstring

服务提供者IP,支持模糊查询。

10.20.x.xx
registryTypestring

注册类型。已废弃,无需设置。

nacos

返回参数

名称类型描述示例值
object
Codeinteger

接口请求的状态码。

200
Messagestring

接口请求返回的信息。

success
Successboolean

调用是否成功。

true
Dataobject

数据结构体。

EdasAppNamestring

EDAS应用名称。

test123
DubboApplicationNamestring

Dubbo应用名称。

cartservice
Versionstring

版本号。

1.0.0
RegistryTypestring

注册类型。

agent
SpringApplicationNamestring

Spring应用名。

edas.service.consumer
ServiceTypestring

服务类型。

springCloud
ServiceNamestring

服务名。

edas.service.consumer
Metadatastring

元数据。

{}
Groupstring

分组。

dubbo
Methodsarray

方法列表。

object
ParameterDetailsstring

参数详情。

{}
NameDetailstring

具体名称。

test
ParameterNamesstring

参数名称。

test
ParameterDefinitionsstring

参数定义。

[{"description":"","name":"arg0","type":"java.lang.String"}]
Pathsstring

方法路径。

["/consumer-echo/feign/{str}"]
ParameterTypesstring

参数类型。

["java.lang.String"]
RequestMethodsstring

请求方法。

GET
ReturnDetailsstring

返回详情。

test
Namestring

名称。

feign2
MethodControllerstring

controller列表。

com.aliware.edas.DemoController
ReturnTypestring

返回类型。

java.lang.String
ReturnDefinitionobject

返回定义。

Typestring

类型。

foo
Idstring

返回值ID。

1

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": {
    "EdasAppName": "test123",
    "DubboApplicationName": "cartservice",
    "Version": "1.0.0",
    "RegistryType": "agent",
    "SpringApplicationName": "edas.service.consumer",
    "ServiceType": "springCloud",
    "ServiceName": "edas.service.consumer",
    "Metadata": "{}",
    "Group": "dubbo",
    "Methods": [
      {
        "ParameterDetails": "{}",
        "NameDetail": "test",
        "ParameterNames": "test",
        "ParameterDefinitions": "[{\"description\":\"\",\"name\":\"arg0\",\"type\":\"java.lang.String\"}]",
        "Paths": "[\"/consumer-echo/feign/{str}\"]",
        "ParameterTypes": "[\"java.lang.String\"]",
        "RequestMethods": "GET",
        "ReturnDetails": "test",
        "Name": "feign2",
        "MethodController": "com.aliware.edas.DemoController",
        "ReturnType": "java.lang.String",
        "ReturnDefinition": {
          "Type": "foo",
          "Id": "1"
        }
      }
    ]
  }
}

错误码

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

阿里云首页 企业级分布式应用服务 EDAS 相关技术圈