查询级联任务列表--慢直播-火山引擎

文档中心

立即注册

导航

查询级联任务列表

最近更新时间：2022.11.01 17:47:37首次发布时间：2022.11.01 17:47:37

查询已创建的级联任务的信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListCascadeTask
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
PlatformName	Query	String	否	筛选条件，关联的上级平台名称	支持模糊搜索
PlatformID	Query	String	否	筛选条件，关联的上级平台 ID	支持模糊搜索
GroupTreeName	Query	String	否	筛选条件，关联的虚拟组织根节点名称	支持模糊搜索
GroupTreeID	Query	String	否	筛选条件，关联的虚拟组织根节点 ID	支持模糊搜索
Order	Query	Integer	否	查询结果排序方式	可选枚举值： 1（正序） -1（倒序，默认）

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
CascadeTasks	Array of objects	查询到的级联任务列表，参考以下 `List<CascadeTasks>` 数据结构说明

List<CascadeTasks> 数据结构说明

字段	类型	说明
TaskID	String	级联任务 ID
TaskName	String	级联任务名称
Description	String	级联任务描述
GroupTreeID	String	关联的虚拟组织根节点 ID
GroupTreeName	String	关联的虚拟组织根节点名称
PlatformID	String	关联的上级平台 ID
PlatformName	String	关联的上级平台名称
Status	String	级联任务状态： created（初始状态） stopped（已停用） trying_register（尝试注册） registered（注册成功） register_fail（注册失败）
Enable	Boolean	是否启用
CreateAt	String	创建时间
UpdateAt	String	更新时间
SharedNodes	String[]	共享的虚拟组织树节点列表

示例

请求示例

GET https://open.volcengineapi.com?Action=ListCascadeTask
&Version=2021-01-01
&PlatformName=vo
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221018141637010174249148072B8DB9",
        "Action": "ListCascadeTask",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "CascadeTasks": [
            {
                "TaskID": "35",
                "TaskName": "vop",
                "Description": "",
                "GroupTreeID": "0ba5842a-9130-4c0b-8480-b152eexxxxxx",
                "GroupTreeName": "test1",
                "PlatformID": "00034",
                "PlatformName": "vop",
                "Status": "registered",
                "Enable": true,
                "CreateAt": "2022-09-14T18:10:41+08:00",
                "UpdateAt": "2022-10-18T04:16:05+08:00",
                "SharedNodes": [
                    "0ba5842a-9130-4c0b-8480-b152eexxxxxx",
                    "856ea30f-c782-4b70-ab5f-54580fxxxxxx",
                    "ac6ff86a-372d-48fe-a382-1e49e7xxxxxx",
                    "e7103bdc-6a4e-41bc-9c7f-5f47d7xxxxxx",
                    "5b68c0ba-77a8-46bf-adc8-d064caxxxxxx",
                    "f9d59848-e503-4075-9b0d-970d36xxxxxx"
                ]
            }
        ]
    }
}