Lists services.
Debugging
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 Resourcesis 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 |
Request syntax
GET /api/v2/services HTTP/1.1
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:
| 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:
Valid values:
| Standard |
| Label | object | No | The tag that is used to filter services. | |
| string | No | The tag format, which is | {"key1":"value1","key2":null} | |
| ServiceStatus | string | No | The service state. Valid values:
| 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 private gateway ID. | gw-1uhcqmsc7x22****** |
| Role | string | No | The server role. Valid values:
Enumeration Value:
| LLMGateway |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "40325405-579C-4D82****",
"Services": [
{
"RequestId": "40325405-579C-4D82********",
"Region": "cn-shanghai",
"CallerUid": "20123*******",
"ParentUid": "11234*******",
"CurrentVersion": 1,
"Cpu": 1,
"Gpu": 0,
"Image": "registry.cn-shanghai.aliyuncs.com/eas/echo_cn-shanghai:v0.0.1-20210129111320",
"PendingInstance": 0,
"RunningInstance": 1,
"TotalInstance": 1,
"InternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/echo",
"IntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/echo",
"LatestVersion": 1,
"Memory": 1024,
"Message": "Service start successfully",
"Namespace": "echo",
"Reason": "RUNNING",
"Resource": "eas-r-xxxxxxx",
"ResourceAlias": "my_resource",
"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\" }",
"ServiceName": "echo",
"ServiceGroup": "my_group",
"Status": "Running",
"CreateTime": "2021-01-29T11:13:20Z",
"UpdateTime": "2021-01-29T11:13:20Z",
"Weight": 100,
"ServiceId": "eas-m-xxasdat",
"ServiceUid": "eas-m-xxasdat\n",
"AccessToken": "MzJiMDI5MDliODc0MTlkYmI0ZDhlYmExYjczYTIyZTE3Zm********",
"Source": "dsw",
"ExtraData": "{\\\"blue_green_services\\\":[\\\"test\\\",\\\"testxxxx\\\"]}",
"Role": "Queue",
"RoleAttrs": "\"{\\\"ApproxMaxLength\\\":null,\\\"Length\\\":null,\\\"MaxPayloadBytes\\\":null}\"",
"SafetyLock": "dangerous",
"SecondaryInternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
"SecondaryIntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
"Labels": [
{
"LabelKey": "key1",
"LabelValue": "value1"
}
],
"WorkspaceId": "123445",
"AppType": "LLM",
"AppConfig": "{\"ModelStorage\":\"oss\"}",
"AppSpecName": "llama_7b_fp16",
"AppVersion": "v1"
}
],
"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-10-08 | The request parameters of the API has changed | View Change Details |
| 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 |