调用BatchForbidVsStream批量禁止VS流_视图计算(VECS)-阿里云帮助中心

禁止某条流的推送，可以预设某个时刻将流恢复。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vs:BatchForbidVsStream		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	是	您的加速域名。	example.com
Channel	string	是	流名称。说明格式为：AppName/StreamName。支持多个，用英文逗号（,）分隔。	live/stream1,live/stream2
LiveStreamType	string	是	用于指定主播推流还是客户端拉流。取值范围： publisher（主播推送）说明目前仅支持：publisher。	publisher
Oneshot	string	否	是否只断流不加入黑名单。取值范围： yes（是） no（否）	yes
ResumeTime	string	否	恢复流的时间。说明 UTC 时间格式，例如：2015-12-01T17:37:00Z	2015-12-01T17:37:00Z

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	B058D71B-76EA-5DF6-ACAF-A617C1E7937F
ForbidResult	array<object>	断流结果。
ForbidResultInfo	object
Result	string	操作结果。取值范围： success（成功） fail（失败）	success
Count	integer	成功或者失败的路数。	2
Detail	string	错误原因。取值范围： ok（成功） exceed-limit（黑名单条数超限） internal-error（内部错误）	ok
Channels	array	流名称列表。
Channel	string	流名称。说明格式为：AppName/StreamName。支持多个，用英文逗号（,）分隔。	live/stream1,live/stream2

示例

正常返回示例

JSON格式

{
  "RequestId": "B058D71B-76EA-5DF6-ACAF-A617C1E7937F",
  "ForbidResult": {
    "ForbidResultInfo": [
      {
        "Result": "success",
        "Count": 2,
        "Detail": "ok",
        "Channels": {
          "Channel": [
            "live/stream1,live/stream2"
          ]
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

特殊错误码

错误代码	描述	HTTP 状态码	语义
InternalError	The request processing has failed due to some unknown error.	500	后台发生未知错误。
InvalidDomain.NotFound	The domain provided does not exist in our records.	404	当前账户下未查到域名。
IllegalOperation	Illegal domain operate is not permitted.	403	不支持当前操作，如：非直播类域名。
InvalidResumeTime.Malformed	Specified parameter ResumeTime is not valid.	400	结束时间错误。
QuotaExceeded.Blacklist	Exceed max blacklist count limit	400	黑名单条数超出上限，默认 10000 条。
ConfigAlreadyExists	Config has already exist.	400	配置已存在。