All Products
Search
Document Center

:ListAppServicesPage

Last Updated:Aug 01, 2024

Queries the services 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:ListAppServicesPage
  • All Resources
    *
    none
none

Request syntax

GET /pop/v1/sam/service/listAppServicesPage

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

1

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

9999

springCloud
PageNumberintegerNo

The ID of the request.

1
PageSizeintegerNo

The returned information.

9999

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

2583E089-99C2-562E-8B7E-73512136****
Messagestring

The details of microservices.

success
TraceIdstring

The page number of the current page.

0be3e0c816394483660457498e****
Dataarray<object>

The total number of pages returned.

object
CurrentPagestring

The page number of the returned page.

1
TotalSizestring

The number of entries returned per page. Valid values: 0 to 9999.

1
PageNumberstring

The returned result.

1
PageSizestring

The name of the application.

9999
Resultarray<object>

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

object
EdasAppNamestring

The total number of instances.

cn-zhangjiakou-micro-service-******
Versionstring

The ID of the application.

1.0.0
InstanceNumlong

The name of the service.

1
EdasAppIdstring

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

hc4fs1****@98314c8790b****
ServiceNamestring

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.
edas.service.provider
Groupstring

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.
springCloud
ErrorCodestring

Indicates whether the microservice list was obtained. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "RequestId": "2583E089-99C2-562E-8B7E-73512136****",
  "Message": "success",
  "TraceId": "0be3e0c816394483660457498e****",
  "Data": [
    {
      "CurrentPage": "1",
      "TotalSize": "1",
      "PageNumber": "1",
      "PageSize": "9999",
      "Result": [
        {
          "EdasAppName": "cn-zhangjiakou-micro-service-******",
          "Version": "1.0.0",
          "InstanceNum": 1,
          "EdasAppId": "hc4fs1****@98314c8790b****",
          "ServiceName": "edas.service.provider",
          "Group": "springCloud"
        }
      ]
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
400Micro.Service.NotFoundThe micro service 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
No change history