删除服务部署的实例 - DeleteV2DeploymentInstance
功能介绍
本接口用于删除指定的单个部署的实例,适用于需要清理或释放不再使用的部署实例资源的场景。调用此接口前,确保已具备相应的删除权限,并提供有效的服务实例ID、部署ID。删除成功后,指定的服务部署实例将被彻底移除,不再对任何请求生效。如果提供的服务实例ID、部署ID无效、服务实例已删除或权限不足,将返回相应的异常信息,提示用户检查输入数据的有效性和权限。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts:service:deleteDeploymentInstance
Read
service *
-
-
-
URI
DELETE /v2/{project_id}/services/{id}/deployments/{deployment_name}/instances/{name}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 账号的项目ID。 默认取值: 不涉及。 |
| id | 是 | String | 参数解释: 服务ID,在创建服务时即可在返回体中获取,也可通过查询服务列表获取当前用户拥有的服务,其中service_id字段即为服务ID。 约束限制: 不涉及。 取值范围: 服务ID。 默认取值: 不涉及。 |
| deployment_name | 是 | String | 参数解释: 部署名称。 |
| name | 是 | String | 参数解释: 服务实例名字,可以为all,为all时去查询所有的服务实例。 约束限制: 不涉及。 取值范围: 服务实例名字。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instance_name | String | 参数解释: 服务实例名字。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
请求示例
强制删除指定服务实例。
DELETE https://{endpoint}/v2/{project_id}/services/{service_id}/deployments/{deployment_id}/instances/{name}?force=true 响应示例
状态码:200
删除成功响应。
{
"instance_name" : "infer-689e24bb-3cf7-48c3-9ab5-67c0ade4dba7-fp74f"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 删除成功响应。 |
| 400 | 请求参数不合法。 |
| 401 | 鉴权非法。 |
| 403 | 权限不足。 |
| 404 | 资源未找到。 |
错误码
请参见错误码。