终止应用运行 - StopApplicationRun
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| DataArtsPlatform:application:stopRun | Write | - | - | - | - |
URI
POST /v1/{project_id}/applications/{application_id}/runs/{run_id}/stop
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 小写字母和数字组成的32位十六进制字符,例如:ff8080817d30ff7b017d3213ba600001。 默认取值: 不涉及。 |
| application_id | 是 | String | 参数解释: 应用ID,应用的唯一标识,可通过应用开发控制台或应用查询接口获取。 约束限制: 不涉及。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:552b5251-8558-4271-9aec-46e5879ab9e5。 默认取值: 不涉及。 |
| run_id | 是 | String | 参数解释: 运行ID,单次运行的唯一标识,通过运行应用相关接口生成并返回。 约束限制: 不涉及。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:59e2e4ed-ad2c-44ec-a52f-5ba8295e68eb。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Workspace-Id | 是 | String | 参数解释: 工作空间ID。 获取方法请参见获取项目ID,例如:6280b8733aea43a2a0799c55aeeb0e68。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| application_id | String | 参数解释: 应用ID,应用的唯一标识。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:fc078dfc-b2da-4052-8aad-4c67c4302264。 |
| message_id | String | 参数解释: 运行消息ID,由系统生成。应用的一次运行会生成一个消息ID。因应用可能涉及交互问答,同一次运行可能涉及多次交互,因此会产生不同的消息ID。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:2c1f93a2-cfc3-4799-abae-bda8edf36d7f。 |
| run_id | String | 参数解释: 运行ID,单次运行的唯一标识。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:2c1f93a2-cfc3-4799-abae-bda8edf36d7f。 |
| session_id | String | 参数解释: 会话ID,会话的唯一标识。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:2350bb6e-7f05-40d6-b65f-2cf0d3fde0a2。 |
| status | String | 参数解释: 应用运行状态。 取值范围: |
| version | String | 参数解释: 应用版本号。标识当前运行的应用版本。 取值范围: 不涉及。 |
请求示例
终止应用运行
POST https://{Endpoint}/v1/{project_id}/applications/{application_id}/runs/{run_id}/stop 响应示例
状态码:200
终止应用运行
{
"application_id" : "06824050-8a2b-4b89-a6c6-d859a4204d8f",
"run_id" : "8ac0dfc9-5535-4a87-9c20-43e41cc871d3",
"message_id" : "8ac0dfc9-5535-4a87-9c20-43e41cc871d3",
"session_id" : "7917dbae-3cd6-455d-a6cd-b19c9b8099ad",
"version" : "1.0",
"status" : "succeeded"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 终止应用运行成功响应。 |
错误码
请参见错误码。