All Products
Search
Document Center

:DescribeAppServiceDetail

Last Updated:Aug 01, 2024

Queries the metadata details of the service of an application.

Debugging

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

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
sae:DescribeAppServiceDetaillist
  • All Resources
    *
    none
none

Request syntax

GET /pop/v1/sam/service/describeAppServiceDetail

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

6dcc8c9e-d3da-478a-a066-86dcf820****

6dcc8c9e-d3da-478a-a066-86dcf820****
ServiceTypestringNo

springCloud

springCloud
ServiceGroupstringNo

springCloud

springCloud
ServiceVersionstringNo

1.0.0

1.0.0
ServiceNamestringNo

edas.service.provider

edas.service.provider

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B2C7874F-F109-5B34-8618-2C10BBA2****
Messagestring

The returned information.

success
TraceIdstring

The ID of the trace. The ID is used to query the details of a request.

0b16399316402420740034918e****
Dataobject

The returned data.

Groupstring

The group to which the service belongs. You can create a custom group.

springCloud
ServiceNamestring

The name of the service.

service-provider
Versionstring

The version of the service. You can create a custom version.

1.0.0
ServiceTypestring

The type of the service. Valid values:

  • dubbo
  • springCloud
springCloud
EdasAppNamestring

The name of the application.

cn-zhangjiakou-micro-service-******
Metadataobject

The metadata. Example: {side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}.

{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}
SpringApplicationNamestring

The name of the Spring Cloud application.

service-provider
DubboApplicationNamestring

The name of the Dubbo application.

service-consumer
Methodsarray<object>

The methods.

object
MethodControllerstring

The class to which the method belongs.

com.serverless.sae.controller.EchoController
ReturnTypestring

The data format of the response.

java.lang.String
ReturnDetailsstring

The details of the response.

test
Namestring

The name of the method.

echo
NameDetailstring

The details of the method.

description
ParameterDetailsarray

The details of the parameters.

string
description
RequestMethodsarray

The request methods. Valid values:

  • GET
  • ALL
string
ALL
ParameterTypesarray

The types of the parameters.

string
["java.lang.String"]
Pathsarray

The request paths. Format:

/path

string
["/echo/{str}"]
ParameterDefinitionsarray<object>

The definition of the parameter.

object
Typestring

The type of the parameter.

java.lang.String
Descriptionstring

The description of the parameter.

description
Namestring

The name of the parameter.

arg0
ErrorCodestring

The returned error code. Valid values:

  • If the call is successful, the ErrorCode parameter is not returned.
  • If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.
Codestring

The HTTP status code. Valid values:

  • 2xx: indicates that the call was successful.
  • 3xx: indicates that the call was redirected.
  • 4xx: indicates that the call failed.
  • 5xx: indicates that a server error occurred.
200
Successboolean

Indicates whether the meta data was obtained. Valid values:

  • true: The metadata was obtained.
  • false: The metadata failed to be obtained.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "B2C7874F-F109-5B34-8618-2C10BBA2****",
  "Message": "success",
  "TraceId": "0b16399316402420740034918e****",
  "Data": {
    "Group": "springCloud",
    "ServiceName": "service-provider",
    "Version": "1.0.0",
    "ServiceType": "springCloud",
    "EdasAppName": "cn-zhangjiakou-micro-service-******",
    "Metadata": {
      "test": "test",
      "test2": 1
    },
    "SpringApplicationName": "service-provider",
    "DubboApplicationName": "service-consumer",
    "Methods": [
      {
        "MethodController": "com.serverless.sae.controller.EchoController",
        "ReturnType": "java.lang.String",
        "ReturnDetails": "test",
        "Name": "echo",
        "NameDetail": "description",
        "ParameterDetails": [
          "description"
        ],
        "RequestMethods": [
          "ALL"
        ],
        "ParameterTypes": [
          "[\"java.lang.String\"]"
        ],
        "Paths": [
          "[\"/echo/{str}\"]"
        ],
        "ParameterDefinitions": [
          {
            "Type": "java.lang.String",
            "Description": "description",
            "Name": "arg0"
          }
        ]
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
400Micro.Service.MetaData.NotFoundThe micro service metadata not found {%s}.
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.

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

Change history

Change timeSummary of changesOperation
2024-05-20The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details