调用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。 |
返回数据
示例
请求示例
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"
}
]
}
}
错误码
访问错误中心查看更多错误码。