調用DescribeWorkGroups獲取已創建的接流工作組。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeWorkGroups

系統規定參數。取值：DescribeWorkGroups。

InstanceId String 是 cityvisual-Instance

實例ID。
PageNumber Integer 否 1

接流工作組列表的頁碼。起始值：1。

默認值：1 。
PageSize Integer 否 10

分頁查詢時設置的每頁行數。最大值：100。

默認值：10。
RegionId String 否 cn-shanghai

地域ID。
WorkGroupId String 否 87

接流工作組ID。

返回數據

名稱 類型 示例值 描述
PageNumber Integer 1

工作組列表的頁碼。起始值：1。

默認值：1 。
PageSize Integer 10

分頁查詢時設置的每頁行數。最大值：100。

默認值：10。
RequestId String E175B041-75A2-4335-B3AC-0FD008F93627

請求ID。
TotalCount Integer 200

該實例下的接流工作組總數。
WorkGroups

接流工作組集合。
CreateTime String 2018-10-10T10:20:30Z

創建工作組的時間。
Description String 描述信息

工作組描述信息。
InstanceId String xxx

實例ID。
Protocol String RTMP

協議。
TheoryCutStatus String False

視頻調度狀態。取值范圍

  • True: 參與視頻調度
  • False: 不參與視頻調度
UpdateTime String 2018-11-10T10:20:30Z

最后一次修改的時間。
WorkGroupId String 3274

接流工作組ID。
WorkGroupName String WorkGroupName

接流工作組名稱。

示例

請求示例


http(s)://[Endpoint]/?Action=DescribeWorkGroups
&InstanceId=cityvisual-Instance
&<公共請求參數>

正常返回示例

XML 格式 

<DescribeWorkGroupsResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <WorkGroups>
        <WorkGroup>
            <CreateTime>2017-12-10T04:04Z</CreateTime>
            <Description>description</Description>
            <WorkGroupName>MyGroup</WorkGroupName>
            <ProtocolType>RTMP</ProtocolType>
            <WorkGroupId>3274</WorkGroupId>
            <UpdateTime>2015-07-27T07:08Z</UpdateTime>
            <TheoryCutStatus>False</TheoryCutStatus>
        </WorkGroup>
    </WorkGroups>
</DescribeWorkGroupsResponse>

JSON 格式 

{
	"PageNumber":"1",
	"TotalCount":"1",
	"PageSize":"10",
	"RequestId":"14A07460-EBE7-47CA-9757-12CC4761D47A",
	"WorkGroups":{
		"WorkGroup":[
			{
				"Description":"description",
				"ProtocolType":"RTMP",
				"CreateTime":"2017-12-10T04:04Z",
				"TheoryCutStatus":"False",
				"UpdateTime":"2017-12-10T04:04Z",
				"WorkGroupId":"3274",
				"WorkGroupName":"MyGroup"
			}
		]
	}
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。