查询拉流转推群组列表--视频直播-火山引擎

文档中心

立即注册

导航

查询拉流转推群组列表

最近更新时间：2024.08.09 10:39:07首次发布时间：2024.08.09 10:39:07

调用 ListPullToPushGroup 接口，查询拉流转推任务群出列表信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=ListPullToPushGroup&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListPullToPushGroup`	接口名称。当前 API 的名称为 `ListPullToPushGroup`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数类型是否必选示例值描述

PageNum Integer 是 1 查询数据的页码，取值范围为 [1,1000]。

PageSize Integer 是 10 每页现实的数据条数，取值范围为 [1,1000]。

参数	类型	是否必选	示例值	描述
PageNum	Integer	是	`1`	查询数据的页码，取值范围为 [1,1000]。
PageSize	Integer	是	`10`	每页现实的数据条数，取值范围为 [1,1000]。
StatusList	Array of Integer	否	`0`	群组的状态，取值及含义如下所示。 `0`: （默认值）可用; `1`: 已删除，不可用。

StatusList

Array of Integer

否

0

群组的状态，取值及含义如下所示。

0: （默认值）可用;
1: 已删除，不可用。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
List	Array of List	`-`	拉流转推群组列表。
Total	Integer	`1`	查询结果的数据条数。

List

参数	类型	示例值	描述
Name	String	`Group001`	群组名称。
ProjectName	String	`default`	群组所属的项目名称。
Tags	Array of Tags	`-`	群组的标签信息。
Status	Float	`0`	群组的状态，取值及含义如下所示。 `0`: 可用; `1`: 已删除，不可用。

参数	类型	示例值	描述
Key	String	`key001`	标签 Key 值。
Value	String	`Valuedes`	标签 Value 值。
Category	String	`Custom`	标签类型，支持以下取值。 `System`：系统内置标签； `Custom`：自定义标签。

请求示例

POST https://live.volcengineapi.com?Action=ListPullToPushGroup&Version=2023-01-01
{
    "PageNum": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListPullToPushGroup",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "List": [
            {
                "Name": "Group001",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key": "key001",
                        "Value": "Valuedes",
                        "Category": "Custom"
                    }
                ],
                "Status": 0
            }
        ],
        "Total": 1
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
429	RequestLimitExceeded.Exist	the resource requested to be created already exists, please rename it	请求创建的资源（域名空间、域名、应用、配置模版、证书）已存在。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.DB	an internal error related to database occurred, please contact the administrator.	出现与数据库相关的内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。