You need to enable JavaScript to run this app.
导航

查询级联任务信息

最近更新时间2022.11.01 17:47:37

首次发布时间2022.11.01 17:47:37

查询指定级联任务的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称GetCascadeTask

Version

Query

String

公共参数,OpenAPI 接口版本

2021-01-01

TaskIDQueryString级联任务 ID可通过调用 ListCascadeTask 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
TaskIDString级联任务 ID
TaskNameString级联任务名称
DescriptionString级联任务描述
GroupTreeIDString关联的虚拟组织根节点 ID
GroupTreeNameString关联的虚拟组织根节点名称
PlatformIDString关联的上级平台 ID
PlatformNameString关联的上级平台名称

Status

String

级联任务状态:

  • created(初始状态)

  • stopped(已停用)

  • trying_register(尝试注册)

  • registered(注册成功)

  • register_fail(注册失败)

EnableBoolean是否启用
CreateAtString创建时间
UpdateAtString更新时间
SharedNodesString[]共享的虚拟组织树节点列表

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022101814360901022508219901FD1608",
        "Action": "GetCascadeTask",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskID": "33",
        "TaskName": "newtest",
        "Description": "",
        "GroupTreeID": "59b7450c-977f-4b99-b396-bb4afexxxxxx",
        "GroupTreeName": "测试",
        "PlatformID": "00033",
        "PlatformName": "new-test",
        "Status": "stopped",
        "Enable": false,
        "CreateAt": "2022-08-25T11:39:47+08:00",
        "UpdateAt": "2022-10-11T10:31:55+08:00",
        "SharedNodes": [
            "59b7450c-977f-4b99-b396-bb4afexxxxxx",
            "a6e65391-16b5-4996-88fd-2e1f90xxxxxx",
            "e3b8f7ed-63b6-4eb9-a061-e15e34xxxxxx"
        ]
    }
}