更新已部署的服务实例
功能介绍
更新已部署的服务实例。用户可以通过该接口更新已部署的服务实例,包括名称和描述等。此接口为异步接口,配套使用接口ShowServiceInstanceDetail,ListServicesInstances来查询服务实例具体情况。目前暂不支持更新实例最小数和模型版本。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v1/workspaces/{workspace_id}/services/instances/{instance_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
workspace_id |
是 |
String |
参数解释:工作空间的ID。 约束限制:不涉及。 取值范围:长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值:不涉及。 |
|
instance_id |
是 |
String |
参数解释:实例的ID。获取方法,请参见获取推理实例ID。 约束限制:不涉及。 取值范围:长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值:不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释:租户token。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source |
否 |
SourceRef object |
参数解释:来源信息,Service信息或者模型信息。 约束限制:不涉及。 |
|
name |
否 |
String |
参数解释:一个服务实例的名称。 约束限制:不涉及。 取值范围:长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、点、空格的组合。 默认取值:不涉及。 |
|
description |
否 |
String |
参数解释:描述信息。 约束限制:不涉及。 取值范围:长度为[0,1024]的除了 “!”、“<”、“>”、“=”、“&”、“"”、“'” 之外的任意字符的组合。 默认取值:不涉及。 |
|
config |
否 |
UpdateServiceInstanceConfig object |
参数解释:更新服务实例时输入的配置。 约束限制:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
参数解释:来源ID。有不同的类型,对于推理服务实例,则为模型的ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字母、数字、中划线(-)的组合。 默认取值:不涉及。 |
|
version_id |
否 |
String |
参数解释:版本ID。有不同的类型,对于推理服务实例,则为模型版本ID 约束限制:不涉及。 取值范围:长度为[1,36]的英文字母、数字、中划线(-)的组合。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource |
是 |
BaseDemand object |
参数解释:资源需求量配置。 约束限制:不涉及。 |
响应参数
状态码:202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
InstanceId object |
参数解释:实例ID。获取方法,请参见获取推理实例ID。 约束限制:不涉及。 取值范围:长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
参数解释:实例ID。获取方法,请参见获取推理实例ID。 约束限制:不涉及。 取值范围:长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值:不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 |
|
error_msg |
String |
参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
|
solution_msg |
String |
参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 |
|
error_msg |
String |
参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
|
solution_msg |
String |
参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 |
|
error_msg |
String |
参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
|
solution_msg |
String |
参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
状态码:408
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 |
|
error_msg |
String |
参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
|
solution_msg |
String |
参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 |
|
error_msg |
String |
参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
|
solution_msg |
String |
参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 |
请求示例
更新已部署的服务实例,具体更新参数如下示例所示。
PUT https://{endpoint}/v1/workspaces/{workspace_id}/services/instances/{instance_id}
{
"source" : {
"id" : "0b5633ba2b904511ad514346f4d23d4b",
"version_id" : "0b5633ba2b904511ad514346f4d23d4b"
},
"name" : "serviceInstanceName1",
"description" : "description",
"config" : {
"model_instance_config" : {
"resource" : {
"min" : 1,
"max" : 1000
}
}
}
}
响应示例
状态码:202
更新推理模型的响应。
{
"id" : "b935d0ef-f4eb-4b95-aff1-9d33ae9f57b6"
}
状态码:400
BadRequest
{
"error_code" : "common.01000001",
"error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}
状态码:401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码:403
Forbidden
{
"error" : {
"code" : "403",
"message" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
},
"error_code" : 403,
"error_msg" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
}
状态码:404
NotFound
{
"error_code" : "common.01000001",
"error_msg" : "response status exception, code: 404"
}
状态码:408
Request Time-out
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
}
状态码:500
InternalServerError
{
"error_code" : "common.00000500",
"error_msg" : "internal error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
202 |
更新推理模型的响应。 |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
NotFound |
|
408 |
Request Time-out |
|
500 |
InternalServerError |
错误码
请参见错误码。