文档

ListServices - 查询服务列表

更新时间:

获取当前用户的服务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eas:ListServicesList
  • Service
    acs:eas:{#regionId}:{#accountId}:service/*

请求语法

GET /api/v2/services

请求参数

名称类型必填描述示例值
Sortstring

排序字段。按时间戳类型默认倒序排序。

CreateTime
Orderstring

排序方式,取值如下:

  • desc(默认值):降序。
  • asc:升序。
asc
Filterstring

模糊匹配字段。只支持按服务名字模糊匹配。

foo
PageNumberinteger

服务列表的请求页码,默认为 1。

1
PageSizeinteger

分页查询时设置的每页显示的服务数量,默认为 100。

100
GroupNamestring

服务群组名称,如何获取服务群组名称,请参见ListServices

foo
ParentServiceUidstring

Band 成员服务对应的主服务 ID。

eas-m-ijafy3c8cxxxx
ServiceTypestring

服务类型,取值如下:

  • Async
  • Standard
  • Offline Task
  • Proxima
枚举值:
  • AsyncAsync
  • StandardStandard
  • OfflineTaskOfflineTask
  • ProximaProxima
Standard
Labelobject

按标签过滤。

string

{"key":"value"}格式填写。Value 可为 null 或空字符,代表只按 Key 过滤,Value 可为任意值。

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

服务运行的状态。

枚举值:
  • CreatingCreating
  • StoppedStopped
  • FailedFailed
  • CompleteComplete
  • CloningCloning
  • StoppingStopping
  • UpdatingUpdating
  • WaitingWaiting
  • HotUpdateHotUpdate
  • CommittingCommitting
  • StartingStarting
  • DeleteFailedDeleteFailed
  • RunningRunning
  • DevelopingDeveloping
  • ScalingScaling
  • DeletedDeleted
  • PendingPending
  • DeletingDeleting
Running
ServiceNamestring

服务名。

echo_test
ServiceUidstring

服务 UID。

eas-m-c9iw3yitxxxx
ResourceNamestring

服务所属的资源组名称或 ID。

eas-r-hd0qwy8cxxxx
WorkspaceIdstring

工作空间 ID。

1234**
QuotaIdstring

配额 ID。

quota1****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

40325405-579C-4D82****
Servicesarray

服务列表。

Service

服务实例。

PageNumberinteger

返回查询的服务列表的当前页码。

1
PageSizeinteger

返回每页显示的服务数量。

100
TotalCountinteger

服务总数。

2

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-23OpenAPI 入参发生变更查看变更详情
2023-09-01OpenAPI 入参发生变更查看变更详情
2023-05-06OpenAPI 入参发生变更查看变更详情