停止流任务 - ModifyFlowStop
功能介绍
停止流任务
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
live:ott:updateFlowStatusStop | Write | - | - | - | - |
URI
PUT /v1/{project_id}/flows/stop
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释： 项目ID，获取方法请参考获取项目ID。 约束限制： 不涉及 取值范围： [1,32] 默认取值： 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
flow_id | 是 | String | 参数解释： 流id 约束限制： 不涉及 取值范围： 长度为[1~64]个字符。 默认取值： 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 参数解释： 用户Token，使用Token鉴权方式时为必填项。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及 取值范围： [1,256] 默认取值： 不涉及 |
Authorization | 否 | String | 参数解释： 使用AK/SK方式认证时必填，携带的鉴权信息。 约束限制： 不涉及 取值范围： [1,256] 默认取值： 不涉及 |
X-Sdk-Date | 否 | String | 参数解释： 请求的发生时间，使用AK/SK方式认证时为必填项。 约束限制： 不涉及 取值范围： [1,256] 默认取值： 不涉及 |
X-Project-Id | 否 | String | 参数解释： 使用AK/SK方式认证时为必填项，携带项目ID信息。 约束限制： 不涉及 取值范围： [1,64] 默认取值： 不涉及 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
status | String | 参数解释： 状态，ACTIVE状态为运行状态,STANDBY状态为未启动状态 取值范围： |
flow_id | String | 参数解释： 流id 取值范围： 限制[1~64]个字符长度 |
状态码：400
请求示例
无
响应示例
状态码：200
修改流状态成功响应
{
"flow_id" : "ec897482-d24b-4d64-aa39-407980902b1d",
"status" : "STANDBY"
} 状态码：400
失败响应
{
"error_code" : "LIVE.100011001",
"error_msg" : "flow task is in standby status"
} 状态码
状态码 | 描述 |
|---|---|
200 | 修改流状态成功响应 |
400 | 失败响应 |
错误码
请参见错误码。
