创建拉流转推群组--视频直播-火山引擎

文档中心

立即注册

导航

创建拉流转推群组

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

调用 CreatePullToPushGroup 接口，创建拉流转推任务群组，为群组绑定项目，您可以通过设置群组实现基于项目的子账号权限细分。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Name	String	是	`RelayGroup001`	群组名称，支持有中文、大小写字母和数字组成，最大长度为 20 个字符。
ProjectName	String	是	`default`	为任务群组设置所属项目，您可以在访问控制-项目列表查看已有项目并对项目进行管理。项目是火山引擎提供的一种资源管理方式，您可以对不同业务或项目使用的云资源进行分组管理，以实现基于项目的账单查看、子账号授权等功能。
Tags	Array of Tags	否	`-`	为任务群组设置资源标签。您可以通过资源标签从不同维度对云资源进行分类和聚合管理，如资源分账等场景。说明如需使用标签进行资源分账，可以在可以在账单管理-费用标签处管理启用标签，将对应标签运用到账单明细等数据中。

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

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=CreatePullToPushGroup&Version=2023-01-01
{
    "Name": "RelayGroup001",
    "ProjectName": "default",
    "Tags": [
        {
            "Key": "key001",
            "Value": "Valauedes",
            "Category": "Custom"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreatePullToPushGroup",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-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.	内部服务超时，请联系技术支持。