查询禁止直播推流列表 - ListStreamForbidden
功能介绍
查询禁推黑名单列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
live:stream:listStreamForbidden
Read
-
-
-
-
URI
GET /v1/{project_id}/stream/blocks
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID,获取方法请参考获取项目ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
domain | 是 | String | 参数解释: 直播域名 约束限制: 不涉及 取值范围: 字符长度为[1-255]位 默认取值: 不涉及 |
app_name | 否 | String | 参数解释: 应用名称 约束限制: 不指定则查询domain下所有应用的禁止直播推流信息 取值范围: 字符长度为[1-128]位 默认取值: 不涉及 |
stream_name | 否 | String | 参数解释: 流名称 约束限制: 不涉及 取值范围: 字符长度为[1-512]位 默认取值: 不涉及 |
page | 否 | Integer | 参数解释: 分页编号 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
size | 否 | Integer | 参数解释: 每页记录数 约束限制: 不涉及 取值范围: 1~100 默认取值: 10 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization | 否 | String | 使用AK/SK方式认证时必填,携带的鉴权信息。 |
X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必填,请求的发生时间。 |
X-Project-Id | 否 | String | 使用AK/SK方式认证时必填,携带项目ID信息。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
total | Integer | 参数解释: 查询结果的总元素数量 取值范围: 不涉及 |
blocks | Array of StreamForbiddenList objects | 参数解释: 禁推黑名单列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
app_name | String | 参数解释: 应用名称 取值范围: 字符长度为[1-128]位 |
stream_name | String | 参数解释: 流名称 取值范围: 字符长度为[1-512]位 |
resume_time | String | 参数解释: 恢复流时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间。 取值范围: 不指定则默认7天,最大禁推为90天,resume_time>当前时间。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
查询禁止直播推流列表。
GET https://{endpoint}/v1/{project_id}/stream/blocks?domain=publish.example.huawei.com&app_name=live 响应示例
状态码:200
查询禁止直播推流列表成功
{
"total" : 2,
"blocks" : [ {
"app_name" : "live",
"stream_name" : "test_001",
"resume_time" : "2018-05-19T21:10:15Z"
}, {
"app_name" : "live",
"stream_name" : "test_002",
"resume_time" : "2018-06-12T20:10:10Z"
} ]
} 状态码:400
查询禁止直播推流列表失败
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
} SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; public class ListStreamForbiddenSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); ListStreamForbiddenRequest request = new ListStreamForbiddenRequest(); try { ListStreamForbiddenResponse response = client.listStreamForbidden(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListStreamForbiddenRequest() response = client.list_stream_forbidden(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListStreamForbiddenRequest{} response, err := client.ListStreamForbidden(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 | 描述 |
|---|---|
200 | 查询禁止直播推流列表成功 |
400 | 查询禁止直播推流列表失败 |
错误码
请参见错误码。

