ListServices - Platform For AI - Alibaba Cloud Documentation Center

Queries a list of services that are created by the current user.

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.

Operation	Access level	Resource type	Condition key	Associated operation
eas:ListServices	get	Service acs:eas:{#regionId}:{#accountId}:service/*	none	none

Request syntax

GET /api/v2/services

Request parameters

Parameter	Type	Required	Description	Example
Sort	string	No	The sort field. By default, the query results are sorted by the timestamp type in descending order.	CreateTime
Order	string	No	The sorting order. Valid values: desc (default): The query results are sorted in descending order. asc: The query results are sorted in ascending order.	asc
Filter	string	No	The field that is used for fuzzy matches. The system performs fuzzy matches only by service name.	foo
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 100.	100
GroupName	string	No	The name of the service group. For more information about how to query the name of a service group, see ListServices .	foo
ParentServiceUid	string	No	The ID of the primary service that corresponds to the Band member service.	eas-m-ijafy3c8cxxxx
ServiceType	string	No	The service type. Valid values: Async Standard Offline Task Proxima Valid values: Async Standard OfflineTask Proxima	Standard
Label	object	No	The tag that is used to filter services.
	string	No	The tag format, which is `{"key":"value"}`. If the tag value is null or an empty string, services are filtered only by tag key. The tag value can be any value.	{"key1":"value1","key2":null}
ServiceStatus	string	No	The service state. Valid values: Creating Stopped Failed Complete Cloning Stopping Updating Waiting HotUpdate Committing Starting DeleteFailed Running Developing Scaling Deleted Pending Deleting	Running
ServiceName	string	No	The service name.	echo_test
ServiceUid	string	No	The user ID (UID) of the service.	eas-m-c9iw3yitxxxx
ResourceName	string	No	The name or ID of the resource group to which the service belongs.	eas-r-hd0qwy8cxxxx
WorkspaceId	string	No	The workspace ID.	123456
QuotaId	string	No	The quota ID.	quota12345
Gateway	string	No	The ID of the private gateway.	gw-1uhcqmsc7x22******

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	40325405-579C-4D82****
Services	array	The services.
	Service	The service.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	100
TotalCount	integer	The total number of entries returned.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "40325405-579C-4D82****",
  "Services": [
    {
      "RequestId": "",
      "Region": "",
      "CallerUid": "",
      "ParentUid": "",
      "CurrentVersion": 0,
      "Cpu": 0,
      "Gpu": 0,
      "Image": "",
      "PendingInstance": 0,
      "RunningInstance": 0,
      "TotalInstance": 0,
      "InternetEndpoint": "",
      "IntranetEndpoint": "",
      "LatestVersion": 0,
      "Memory": 0,
      "Message": "",
      "Namespace": "",
      "Reason": "",
      "Resource": "",
      "ResourceAlias": "",
      "ServiceConfig": "",
      "ServiceName": "",
      "ServiceGroup": "",
      "Status": "",
      "CreateTime": "",
      "UpdateTime": "",
      "Weight": 0,
      "ServiceId": "",
      "ServiceUid": "",
      "AccessToken": "",
      "Source": "",
      "ExtraData": "",
      "Role": "",
      "RoleAttrs": "",
      "SafetyLock": "",
      "SecondaryInternetEndpoint": "",
      "SecondaryIntranetEndpoint": "",
      "Labels": [
        {
          "LabelKey": "",
          "LabelValue": ""
        }
      ],
      "WorkspaceId": "",
      "AppType": "",
      "AppConfig": "",
      "AppSpecName": "",
      "AppVersion": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 2
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-31	The request parameters of the API has changed	View Change Details
2024-01-23	The request parameters of the API has changed	View Change Details
2023-09-01	The request parameters of the API has changed	View Change Details
2023-05-06	The request parameters of the API has changed	View Change Details