All Products
Search
Document Center

Enterprise Distributed Application Service:GetServiceDetail

Last Updated:Jan 08, 2024

Queries service details.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ReadServiceRead
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

POST /pop/sp/api/mseForOam/getServiceDetail

GET /pop/sp/api/mseForOam/getServiceDetail

Request parameters

ParameterTypeRequiredDescriptionExample
regionstringYes

The region ID of the service.

cn-hangzhou
namespacestringYes

The ID of the namespace.

cn-hangzhou:doc-test
originstringNo

The source of the data. Valid values:

  • agent: Use this value if you use the service query feature of the latest version to pass the query result.
  • registry: Use this value if you use the service query feature of the earlier version to pass the query result.
agent
serviceTypestringNo

The type of the service. Valid values:

  • dubbo
  • springCloud
  • hsf
  • istio
springCloud
appIdstringYes

The ID of the application.

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

The source of the service. Set the value to edas.

edas
serviceIdstringNo

The ID of the service. This parameter is deprecated. You can ignore it.

com.alibabacloud.hipstershop.CartService
serviceNamestringNo

The name of the service.

com.alibabacloud.hipstershop.CartService
serviceVersionstringNo

The version of the service.

1.0.0
groupstringNo

The group to which the service belongs.

DUBBO
ipstringNo

The IP address of the service provider. Fuzzy searches are supported.

10.20.x.xx
registryTypestringNo

The type of the service registry. This parameter is deprecated. You can ignore it.

nacos

Response parameters

ParameterTypeDescriptionExample
object

The content returned.

Codeinteger

The HTTP status code returned.

200
Messagestring

The message returned for the request.

success
Successboolean

Indicates whether the call was successful.

true
Dataobject

The data structure.

EdasAppNamestring

The name of the Enterprise Distributed Application Service (EDAS) application.

test123
DubboApplicationNamestring

The name of the Dubbo application.

cartservice
Versionstring

The version number.

1.0.0
RegistryTypestring

The type of the service registry.

agent
SpringApplicationNamestring

The name of the Spring application.

edas.service.consumer
ServiceTypestring

The type of the service.

springCloud
ServiceNamestring

The name of the service.

edas.service.consumer
Metadatastring

The metadata.

{}
Groupstring

The group.

dubbo
Methodsobject []

The methods.

ParameterDetailsstring

The parameter details.

{}
NameDetailstring

The specific name.

test
ParameterNamesstring

The parameter names.

test
ParameterDefinitionsstring

The parameter definitions.

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

The method paths.

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

The parameter types.

["java.lang.String"]
RequestMethodsstring

The request methods.

GET
ReturnDetailsstring

The response details.

test
Namestring

The name of the service.

feign2
MethodControllerstring

The controllers.

com.aliware.edas.DemoController
ReturnTypestring

The type of the response.

java.lang.String
ReturnDefinitionobject

The definition of the value returned by the method.

Typestring

The type of the response.

foo
Idstring

The ID of the return value.

1

Examples

Sample success responses

JSONformat

{
  "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"
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.