ListAppServicesPage

更新时间:
复制 MD 格式

Call ListAppServicesPage to get a list of application services.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:ListAppServicesPage

*All Resource

*

None None

Request syntax

GET /pop/v1/sam/service/listAppServicesPage HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AppId

string

Yes

The application ID.

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

ServiceType

string

Yes

The service type. Valid values:

  • Dubbo

  • Spring Cloud

springCloud

PageNumber

integer

No

The page number.

1

PageSize

integer

No

The page size. The value must be an integer from 0 to 9,999.

9999

Response elements

Element

Type

Description

Example

object

The data returned.

RequestId

string

The request ID.

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

Message

string

A message that describes the outcome of the request.

success

TraceId

string

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

0be3e0c816394483660457498e****

Data

array<object>

The service list.

array<object>

The service list.

CurrentPage

string

The current page number.

1

TotalSize

string

The total number of entries.

1

PageNumber

string

The page number.

1

PageSize

string

The number of entries per page. The value must be in the range of 0 to 9999.

9999

Result

array<object>

The returned results.

object

The returned results.

EdasAppName

string

The application name.

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

Version

string

The service version. This value is user-defined.

1.0.0

InstanceNum

integer

The number of instances.

1

EdasAppId

string

The application ID.

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

ServiceName

string

The service name.

edas.service.provider

Group

string

The service group. This value is user-defined.

springCloud

ErrorCode

string

The error code.

  • This parameter is not returned if the request is successful.

  • This parameter is returned if the request fails. For more information, see the Error codes section in this topic.

Code

string

The API status code or POP error code. Valid values:

  • 2xx: Success.

  • 3xx: Redirect.

  • 4xx: client error.

  • 5xx: server error.

200

Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "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 code

Error code

Error message

Description

400 Micro.Service.NotFound The micro service not found {%s}.
400 InvalidParameter.Obviously The specified parameter is invalid {%s}.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.