All Products
Search
Document Center

Microservices Engine:GetServiceListPage

Last Updated:Nov 20, 2024

Queries the version of a microservices application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
mse:GetServiceListPageget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringNo

The region ID.

cn-hangzhou
NamespacestringNo

The name of the MSE namespace.

default
AppNamestringNo

The application name.

example-app
ServiceTypestringNo

The service type.

springCloud
AppIdstringNo

The application ID.

dez4xxxxx@f3f75ed8ffxxxxx
ServiceNamestringNo

The service name.

sc-A
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

10
IpstringNo

The IP address from which the query is initiated.

223.5.5.5
AcceptLanguagestringNo

The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.

zh

Response parameters

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the request was successful.

True
Messagestring

The request information.

OK
RequestIdstring

The request ID.

A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx
Dataobject

The response to the request.

Resultarray<object>

The data on the current page.

MscServiceResponseobject
AppNamestring

The application name.

example-app
Versionstring

The service version.

1
InstanceNuminteger

The number of service nodes.

1
GmtModifyTimestring

The time when the service was last updated.

123456
AppIdstring

The application ID.

dez4xxxxx@f3f75ed8ffxxxxx
ServiceNamestring

The service name.

sc-A
Groupstring

The group to which the service belongs.

DEFAULT_GROUP
TotalSizestring

The total number of entries returned.

100
PageNumberstring

The page number.

1
PageSizestring

The number of entries per page.

10

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "Message": "OK",
  "RequestId": "A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx",
  "Data": {
    "Result": [
      {
        "AppName": "example-app",
        "Version": "1",
        "InstanceNum": 1,
        "GmtModifyTime": "123456",
        "AppId": "dez4xxxxx@f3f75ed8ffxxxxx",
        "ServiceName": "sc-A",
        "Group": "DEFAULT_GROUP"
      }
    ],
    "TotalSize": "100",
    "PageNumber": "1",
    "PageSize": "10"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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

Change history

Change timeSummary of changesOperation
2024-09-25The response structure of the API has changedView Change Details
2023-09-13The request parameters of the API has changedView Change Details