更新时间:2024-03-21 GMT+08:00

查询服务列表

获取当前用户服务列表。

示例代码

在ModelArts notebook平台,Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权

  • 场景1:查询当前用户所有服务
    1
    2
    3
    4
    5
    6
    from modelarts.session import Session 
    from modelarts.model import Predictor 
    
    session = Session() 
    predictor_list = Predictor.get_service_list(session)
    print(predictor_list)
    
  • 场景2:按照检索条件查询当前用户服务
    1
    2
    3
    4
    5
    6
    from modelarts.session import Session 
    from modelarts.model import Predictor 
    
    session = Session()
    predictor_list = Predictor.get_service_list(session, service_name="digit", order="asc", offset="0", infer_type="real-time")
    print(predictor_list)
    

参数说明

表1 查询检索参数说明

参数

是否必选

参数类型

描述

session

Object

会话对象,初始化方法见Session鉴权

service_id

String

服务ID,默认不过滤服务ID。

service_name

String

服务名称,默认不过滤服务名。

infer_type

String

推理方式,取值为:real-time/batch,默认不过滤推理方式。

offset

Integer

分页列表的起始页,默认为:“0”

limit

Integer

指定每一页返回的最大条目数,默认为:“1000”

service_status

String

服务状态,默认不过滤服务状态。可根据服务状态查询,取值如下。

  • running:运行中,服务正常运行,正在计费。
  • deploying:部署中,服务正在部署,调度资源部署等。
  • concerning:告警,后端实例异常,可能正在计费。例如多实例的情况下,有的实例正常,有的实例异常。正常的实例会产生费用,此时服务状态是concerning。
  • failed:失败,服务部署失败,失败原因可以查看事件和日志标签。
  • stopped:停止。
  • finished:只有批量服务会有这个状态,表示运行完成。

sort_by

String

指定排序字段,可选“publish_at”“service_name”,默认可选“publish_at”

order

String

排序方式,可选“asc”“desc”,代表递增排序及递减排序,默认为:“desc”

model_id

String

模型ID,默认不过滤模型ID。

表2 get_service_list返回参数说明

参数

参数类型

描述

total_count

Integer

不分页的情况下,符合查询条件的总服务数量。

count

Integer

当前查询结果的服务数量,不设置offset、limit查询参数时,count与total相同。

services

service结构数组

查询到的服务集合。

表3 service结构

参数

参数类型

描述

service_id

String

服务ID。

service_name

String

服务名称。

description

String

服务描述。

tenant

String

服务归属租户。

project

String

服务归属项目。

owner

String

服务归属用户。

publish_at

Number

服务最新的发布时间,距'1970.1.1 0:0:0 UTC'的毫秒数。

infer_type

String

推理方式,取值为:real-time/batch。

status

String

服务状态,取值为:running/deploying/concerning/failed/stopped/finished。

progress

Integer

部署进度,当状态是deploying时,返回。

invocation_times

Number

服务的总调用次数。

failed_times

Number

服务调用失败次数。

is_shared

Boolean

是否是订阅的服务。

shared_count

Number

订阅的服务数。