Lists services.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eas:ListServices |
get |
*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:
|
asc |
| Filter |
string |
No |
The filter for a fuzzy search. You can perform a fuzzy search only by service name. |
foo |
| PageNumber |
integer |
No |
The page number of the service list. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of services on each page for a paged query. Default value: 100. |
100 |
| GroupName |
string |
No |
The name of the service group. For more information, see ListServices . |
foo |
| ParentServiceUid |
string |
No |
The ID of the primary service to which the member service in an audience group belongs. |
eas-m-ijafy3c8cxxxx |
| ServiceType |
string |
No |
The service type. Valid values:
Valid values:
|
Standard |
| Label |
object |
No |
Filter by label. |
|
|
string |
No |
Specify the label in the |
{"key1":"value1","key2":null} |
|
| ServiceStatus |
string |
No |
The running status of the service. Valid values:
|
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 resource group to which the service belongs. |
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:
|
LLMGateway |
| ResourceType |
string |
No |
The type of resource that the service uses. Valid values:
Valid values:
|
PublicResource |
| IncludeNoWorkspace |
boolean |
No |
Specifies whether to include services that are not in any workspace. Default value: true. |
true |
| ResourceAliasName |
string |
No |
The custom name of the resource group. |
example |
| ResourceId |
string |
No |
The ID of the resource group. For more information, see ListResources. |
eas-r-asdas**** |
| ResourceBurstable |
boolean |
No |
Specifies whether to enable a burstable resource pool for the service. Valid values:
|
true |
| CronscalerEnabled |
boolean |
No |
Specifies whether to enable scheduled auto scaling for the service. Valid values:
|
true |
| AutoscalerEnabled |
boolean |
No |
Specifies whether to enable Auto Scaling for the service. Valid values:
|
true |
| TrafficState |
string |
No |
Specifies whether the service accepts traffic from the group. This parameter applies only to services in a service group. Valid values:
|
grouping |
| CallerUid |
string |
No |
The UID of the account that created the service. |
19989224166xxxxxxx |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| RequestId |
string |
The request ID. |
40325405-579C-4D82**** |
| Services |
array |
The list of services. |
|
| Service |
The service instance. |
||
| PageNumber |
integer |
The page number of the current page. |
1 |
| PageSize |
integer |
The number of services on each 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.