All Products
Search
Document Center

Platform For AI:ListServices

Last Updated:May 11, 2026

Lists 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

eas:ListServices

get

*Service

acs:eas:{#regionId}:{#accountId}:service/*

None None

Request syntax

GET /api/v2/services HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

Sort

string

No

The sort field. By default, results are sorted by timestamp in descending order.

CreateTime

Order

string

No

The sort order. Valid values:

  • desc (default): descending.

  • asc: ascending.

asc

Filter

string

No

The keyword for a fuzzy search. This parameter supports fuzzy searches by service name only.

foo

PageNumber

integer

No

The page number of the results to return. The default value is 1.

1

PageSize

integer

No

The number of services to return per page. The default value is 100.

100

GroupName

string

No

The name of the service group. To learn how to obtain this name, see ListServices.

foo

ParentServiceUid

string

No

The UID of the primary service. This parameter applies to member services in a service group.

eas-m-ijafy3c8cxxxx

ServiceType

string

No

The service type. Valid values:

  • Async

  • Standard

  • Queue

  • LLM

  • RAG

  • Serverless

  • LLMGatewayService

  • OfflineTask

  • SDCluster

  • ScalableJob

  • ScalableJobService

  • AssistantJob

Valid values:

  • Async :

    asynchronous service

  • Standard :

    standard deployment

  • OfflineTask :

    offline task

  • Proxima :
    Proxima

Standard

Label

object

No

Filters services by label.

string

No

Specify the label in the {"key":"value"} format. If the value is null or an empty string, the system filters by key only.

{"key1":"value1","key2":null}

ServiceStatus

string

No

The status of the service.

Valid values:

  • Creating :

    Creating

  • Stopped :

    Stopped

  • Failed :

    Failed

  • Complete :

    Complete

  • Cloning :

    Cloning

  • Stopping :

    Stopping

  • Updating :

    Updating

  • Waiting :

    Waiting

  • HotUpdate :

    HotUpdate

  • Committing :

    Committing

  • Starting :

    Starting

  • DeleteFailed :

    DeleteFailed

  • Running :

    Running

  • Developing :

    Developing

  • Scaling :

    Scaling

  • Deleted :

    Deleted

  • Pending :

    Pending

  • Deleting :

    Deleting

Running

ServiceName

string

No

The service name.

echo_test

ServiceUid

string

No

The service UID.

eas-m-c9iw3yitxxxx

ResourceName deprecated

string

No

The name or ID of the service's resource group.

eas-r-hd0qwy8cxxxx

WorkspaceId

string

No

The workspace ID.

1234**

QuotaId

string

No

The quota ID.

quota1****

Gateway

string

No

The private gateway ID.

gw-1uhcqmsc7x22******

Role

string

No

The service role.

Valid values:

  • DataLoader :

    DataLoader

  • FrontEnd :

    FrontEnd

  • DataSet :

    DataSet

  • SDProxy :

    SDProxy

  • LLMScheduler :

    LLMScheduler

  • ScalableJob :

    ScalableJob

  • LLMGateway :

    LLMGateway

  • Job :

    Job

  • Queue :

    Queue

LLMGateway

ResourceType

string

No

The type of resource the service uses. Valid values:

  • PublicResource

  • DedicatedResource

  • Lingjun

  • SelfManagedLingjun

Valid values:

  • Lingjun :

    Lingjun resource quota

  • PublicResource :

    public resource group

  • DedicatedResource :

    dedicated resource group

  • SelfManagedLingjun :

    Self-managed Lingjun resource group

PublicResource

IncludeNoWorkspace

boolean

No

Specifies whether to include services that do not belong to any workspace. The default value is true.

true

ResourceAliasName

string

No

The custom name of the resource group.

example

ResourceId

string

No

The ID of the resource group. To learn how to query for this ID, see ListResources.

eas-r-asdas****

ResourceBurstable

boolean

No

Specifies whether to enable a burstable resource pool for the service.

Valid values:

  • true :

    true

  • false :

    false

true

CronscalerEnabled

boolean

No

Specifies whether to enable scheduled auto scaling for the service.

Valid values:

  • true :

    true

  • false :

    false

true

AutoscalerEnabled

boolean

No

Specifies whether to enable Auto Scaling for the service.

Valid values:

  • true :

    true

  • false :

    false

true

TrafficState

string

No

Specifies whether the service accepts group traffic. This parameter applies only to services within a service group.

Valid values:

  • standalone :

    No

  • grouping :

    Yes

grouping

CallerUid

string

No

The UID of the account that created the service.

19989224166xxxxxxx

Accessibility

string

No

PUBLIC

Response elements

Element

Type

Description

Example

object

The response.

RequestId

string

The request ID.

40325405-579C-4D82****

Services

array

The list of services.

Service

A service instance.

PageNumber

integer

The current page number.

1

PageSize

integer

The number of services per page.

100

TotalCount

integer

The total number of services.

2

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Services": [
    {
      "ServiceGroup": "my_group",
      "Memory": 1024,
      "Cpu": 1,
      "Image": "registry.cn-shanghai.aliyuncs.com/eas/echo_cn-shanghai:v0.0.1-20210129111320",
      "Gpu": 0,
      "TotalInstance": 1,
      "AccessToken": "MzJiMDI5MDliODc0MTlkYmI0ZDhlYmExYjczYTIyZTE3Zm********",
      "ResourceBurstable": true,
      "InternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/echo",
      "ResourceAlias": "my_resource",
      "Status": "Running",
      "TrafficState": "standalone",
      "RequestId": "40325405-579C-4D82********",
      "Resource": "eas-r-xxxxxxx",
      "SecondaryInternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
      "Labels": [
        {
          "LabelValue": "value1",
          "LabelKey": "key1"
        }
      ],
      "Namespace": "echo",
      "Weight": 100,
      "Role": "Queue",
      "SecondaryIntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
      "PendingInstance": 0,
      "ServiceName": "echo",
      "SafetyLock": "dangerous",
      "Region": "cn-shanghai",
      "AppType": "LLM",
      "InstanceCountInResource": {
        "Quota": 10,
        "Public": 10,
        "Dedicated": 10
      },
      "IntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/echo",
      "QuotaId": "quotaxxxxx",
      "Message": "Service start successfully",
      "CurrentVersion": 1,
      "RunningInstance": 1,
      "WorkspaceId": "123445",
      "CallerUid": "20123*******",
      "Reason": "RUNNING",
      "Source": "dsw",
      "ServiceId": "eas-m-xxasdat",
      "AppVersion": "v1",
      "CronscalerEnabled": true,
      "ServiceConfig": "{\"metadata\":{\"cpu\":1,\"instance\":1,\"memory\":1024},\"name\":\"echo\",\"processor_entry\":\"libecho.so\",\"processor_path\":\"http://oss-cn-hangzhou-zmf.aliyuncs.com/059247/echo_processor_release.tar.gz\",\"processor_type\":\"cpp\"}",
      "Gateway": "gw-xxxxxx",
      "AppSpecName": "llama_7b_fp16",
      "GPUCorePercentage": 50,
      "GPUMemory": 20,
      "AppConfig": "{\"ModelStorage\":\"oss\"}",
      "CreateTime": "2021-01-29T11:13:20Z",
      "AutoscalerEnabled": true,
      "ExtraData": "{\"blue_green_services\":[\"test\",\"testxxxx\"]}",
      "LatestVersion": 1,
      "UpdateTime": "2021-01-29T11:13:20Z",
      "ServiceUid": "eas-m-xxasdat\n",
      "ParentUid": "11234*******",
      "RoleAttrs": "{\"ApproxMaxLength\":null,\"Length\":null,\"MaxPayloadBytes\":null}"
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 2
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.