查询服务更新日志 - ShowServiceUpdateLogs

功能介绍

查询实时服务更新日志。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:service:getLogs
Read
service *
g:ResourceTag/<tag-key>
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
modelarts:service:getLogs	Read	service *	g:ResourceTag/<tag-key>	-	-

URI

GET /v1/{project_id}/services/{service_id}/logs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	用户项目ID。获取方法请参见获取项目ID和名称。
service_id	是	String	服务ID。

表2 Query参数
参数	是否必选	参数类型	描述
update_time	否	Number	待过滤的更新时间，查询在线服务更新日志可使用，可准确过滤出某次更新任务；默认不过滤。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
service_name	String	服务名称。
service_id	String	服务ID。
logs	Array of Log objects	服务的更新记录。

表5 Log
参数	参数类型	描述
update_time	Number	更新时间，距“1970.1.1 0:0:0 UTC”的毫秒数。
result	String	更新结果，取值为： SUCCESS：成功 FAIL：失败 RUNNING：运行中
config	Array of ServiceLogConfig objects	模型运行配置。
success_num	Number	操作成功的节点数，当infer_type为edge时会返回此值。
failed_num	Number	操作失败的节点数，当infer_type为edge时会返回此值。
result_detail	Array of UpdateResult objects	操作结果详情，当infer_type为edge时会返回此值。
cluster_id	String	专属资源池ID。
extend_config	Array of strings	服务个性化配置。

表6 ServiceLogConfig
参数	参数类型	描述
model_id	String	公共参数。模型ID。通过调用查询AI应用列表接口可以获取。
model_name	String	模型名称。
model_version	String	模型版本。
weight	Integer	real-time类型必选。权重百分比，分配到此模型的流量权重，仅当infer_type为real-time时需要配置，多个权重相加必须等于100；当在一个在线服务中同时配置了多个模型版本且设置不同的流量权重比例时，持续地访问此服务的预测接口，ModelArts会按此权重比例将预测请求转发到对应的模型版本实例。
specification	String	资源规格，当infer_type为real-time/edge时会返回此值。
custom_spec	CustomSpec object	自定义资源规格配置。
envs	Map<String,String>	运行模型需要的环境变量键值对。
cluster_id	String	专属资源池ID。
instance_count	Integer	模型部署的实例数，当infer_type为real-time时会返回此值。
additional_properties	Map<String,ModelAdditionalProperties>	模型部署附加属性，便于服务实例管理。

表7 CustomSpec
参数	参数类型	描述
gpu_p4	Float	GPU个数，可选，默认不使用，支持配置小数，输入值不能小于0（最多支持2位小数，小数点后第3位做四舍五入处理）。
memory	Integer	内存，单位为MB，仅支持整数。
cpu	Float	CPU核数，支持配置小数，输入值不能小于0.01（最多支持2位小数，小数点后第3位做四舍五入处理）。
ascend_a310	Integer	Ascend芯片个数，可选，默认不使用，不支持与gpu同时配置。

表8 ModelAdditionalProperties
参数	参数类型	描述
log_volume	Array of LogVolume objects	主机日志目录挂载。仅支持使用专属资源池部署服务场景。如果用户使用公共资源池部署服务，则不支持配置该参数，否则会报错。
max_surge	Float	必须大于0，不配置默认值为1。当小于1时，代表滚动升级时增加的实例数的百分比；当大于1时，代表滚动升级时最大扩容的实例数。
max_unavailable	Float	必须大于0，不配置默认值为0。当小于1时，代表滚动升级时允许缩容的实例数的百分比；当大于1时，代表滚动升级时允许缩容的实例数。
termination_grace_period_seconds	Integer	容器优雅停止时间。
persistent_volumes	Array of PersistentVolumes objects	持久化存储挂载配置。
dew_secret	DewSecret object	DEW凭据

表9 LogVolume
参数	参数类型	描述
host_path	String	主机上要映射的日志路径。
mount_path	String	容器中的日志路径。

**表10** PersistentVolumes
参数	参数类型	描述
name	String	存储卷的名称。
mount_path	String	存储卷在容器中的挂载路径。如：/tmp。请不要挂载在系统目录下，如“/”、“/var/run”等，会导致容器异常。建议挂载在空目录下，若目录不为空，请确保目录下无影响容器启动的文件，否则文件会被替换，导致容器启动异常，工作负载创建失败。
storage_type	String	挂载类型sfs_turbo极速文件系统挂载。
source_address	String	挂载源路径，挂载为极速文件时为sfs turbo id。

**表11** DewSecret
参数	参数类型	描述
secret_name	String	DEW凭据名称

**表12** UpdateResult
参数	参数类型	描述
result	Boolean	操作结果，true代表成功，false表示操作失败。
node_name	String	边缘节点名称。
operation	String	操作类型，取值： deploy：部署 delete：删除
node_id	String	边缘节点ID。在IEF上创建边缘节点后可得到。

请求示例

GET https://{endpoint}/v1/{project_id}/services/{service_id}/logs

响应示例

状态码：200

服务更新日志

{
  "service_name" : "mnist",
  "service_id" : "195c1f2d-136d-40af-a0f3-db5717d2634a",
  "logs" : [ {
    "result" : "SUCCESS",
    "update_time" : 1574770228888,
    "config" : [ {
      "model_version" : "0.0.1",
      "specification" : "modelarts.vm.cpu.2u",
      "model_name" : "mnist",
      "weight" : 100,
      "model_id" : "0e07b41b-173e-42db-8c16-8e1b44cc0d44",
      "instance_count" : 1
    } ]
  } ]
}